# scrypath v0.3.0 - Table of Contents

Ecto-native search indexing and orchestration for Elixir apps

## Pages

- Getting Started
  - [Scrypath](readme.md)
  - [Getting Started](getting-started.md)

- Phoenix
  - [Phoenix Walkthrough](phoenix-walkthrough.md)
  - [Phoenix Contexts](phoenix-contexts.md)
  - [Phoenix Controllers And JSON](phoenix-controllers-and-json.md)
  - [Phoenix LiveView](phoenix-liveview.md)

- Operations
  - [Scrypath Architecture](architecture.md)
  - [Sync Modes And Visibility](sync-modes-and-visibility.md)

- Maintainers
  - [Releasing Scrypath](releasing.md)

## Modules

- [Scrypath](Scrypath.md): Runtime reflection helpers for searchable schemas declared with `use Scrypath`.
- [Scrypath.Backend](Scrypath.Backend.md): Internal backend behavior for Scrypath runtime adapters.
- [Scrypath.Config](Scrypath.Config.md): Internal runtime configuration helpers for Scrypath.
- [Scrypath.Document](Scrypath.Document.md): Internal projected search document used between Scrypath orchestration layers.
- [Scrypath.Meilisearch](Scrypath.Meilisearch.md): Meilisearch-specific runtime entrypoints for Scrypath.
- [Scrypath.Oban](Scrypath.Oban.md): Narrow Oban helpers for composing Scrypath sync jobs into `Ecto.Multi`.

- [Scrypath.Operator.State](Scrypath.Operator.State.md): Public normalized work-item state used by `Scrypath.Operator.Status`.

- [Scrypath.Operator.Status](Scrypath.Operator.Status.md): Public status snapshot returned by `Scrypath.sync_status/2`.

- [Scrypath.Projection](Scrypath.Projection.md): Document projection for schemas declared with `use Scrypath`.
- [Scrypath.Query](Scrypath.Query.md): Internal normalized search query struct used by the common search path and
backend adapters.

- [Scrypath.Schema](Scrypath.Schema.md): Metadata-only schema declaration support for `use Scrypath`.

## Mix Tasks

- [mix verify.phase10](Mix.Tasks.Verify.Phase10.md): Runs the automated release-confidence verification flow for Phase 10.
- [mix verify.phase11](Mix.Tasks.Verify.Phase11.md): Runs the automated release-alignment verification flow for Phase 11.
- [mix verify.phase5](Mix.Tasks.Verify.Phase5.md): Runs the automated verification flow for Phase 5.
- [mix verify.phase8](Mix.Tasks.Verify.Phase8.md): Runs the automated verification flow for Phase 8.
- [mix verify.release_publish](Mix.Tasks.Verify.ReleasePublish.md): Verifies the live publish contract for a released Scrypath version.