Docs map

Find the guide for your next step.

Use this map when you know the work in front of you: add the first searchable schema, wire Phoenix params, protect tenant filters, recover drift, or run the example app.

First hour

Start with one schema and one context.

Repository README Open the canonical install, claim envelope, and route map before choosing a deeper guide. Scope and reopen policy Check feature-lane reopen triggers and out-of-scope boundaries before requesting broader product work.

Quick path

Install the package, declare one schema, sync one record, and make a search call you can inspect.

Golden path

Mental model

Understand where Scrypath fits in a Phoenix app before you thread it through write paths.

JTBD and user flows

Meilisearch concepts

Learn the index, document, task, settings, backup, and projection vocabulary Scrypath expects.

Open the concepts guide

High-signal guides

Choose by job, not by file name.

Support and compatibility Check supported Elixir and OTP versions, install guidance, and which verification command to run before filing an issue. Report an integration issue Use this when a real app integration fails and you need to provide enough context to reproduce it. Request-edge search Normalize controller or LiveView params once, then pass plain search options into your context. Composing real-app search Reuse defaults and fixed scopes across search pages without hiding the context boundary. Related data and reindexing Keep documents current when associated records change, and decide when to backfill or rebuild. Meilisearch operations Run the backend deliberately: keys, storage, capacity, backups, upgrades, and task visibility. Multitenancy Inject tenant filters safely for shared indexes so user filters cannot drop the tenant guard.

Tenant safety

Keep tenant filters impossible to forget.

Multitenancy

Declare the tenant boundary with tenant_field:, inspect it with schema_capabilities/1, and apply it at search time with tenant_scope:.

Open the guide

Why it matters

If tenant filters behave like ordinary user filters, a later option can silently replace them. Scrypath gives that guard a first-class path.

Example apps

Run the Phoenix paths before you depend on them.

Phoenix + Meilisearch example

Exercise inline sync, Oban-backed sync, related-data fan-out, and live Meilisearch behavior against a real Phoenix app.

Open the runbook

E-commerce/admin showcase

Click through tenant-scoped catalog search, category facets, related-data propagation, and the optional operator UI in a realistic demo app.

Open the showcase

Support posture

Use mix verify.adopter for a fast local confidence check. Use mix verify.adopter --live when Meilisearch and the example app prerequisites are available. Send outside-adopter evidence through the intake guide.

See support guide