Guides
The guides start from an integration task and end with an operational result. If you have not yet resolved and translated a record, begin with the tutorial.
If you are setting up a community rather than integrating a service, begin with Idiolect for a new community, then use the four community-operation guides below.
Project-integration path
For a first application, take these steps in order:
- Index a firehose into your own handler and choose a cursor store.
- Run the orchestrator HTTP API over the indexed catalog.
- Configure authenticated sessions before adding a record-publishing path.
This path connects the read side, query side, and authenticated write side without changing the function of any individual guide.
Task index
| Guide | When to reach for it |
|---|---|
| Index a firehose | You want to stream commits from a PDS firehose into your own indexer. |
| Run the orchestrator HTTP API | You want a read-only query surface over cataloged records. |
| Run the observer daemon | You want to fold encounter-family records into observation records. |
| Author a verification runner | You want to add a new property kind to the verifier. |
| Publish and resolve a lens | You have a panproto lens and want it on the network. |
| Migrate records across a revision | A schema you depend on changed, and you want to lift records across the change. |
| Configure OAuth sessions | You want a session store the publishing path can use. |
| Run codegen | You edited a lexicon or a spec and need the generated tree refreshed. |
| Author a community vocabulary | You want to extend an open enum or publish a typed knowledge graph. |
| Bundle records into a dialect | You want to ship a coherent set of idiolects as one canonical bundle. |
| Operate a community workspace | You need local policy, authorities, packages, diagnostics, and resource limits. |
| Govern definition changes | You need compatibility consequences, attributable reviews, and conclusive verification. |
| Sign releases and run migrations | You need immutable signed releases and resumable operational state. |
| Federate and export | You need peer-community dependencies, semantic mappings, or a portable exit. |
For extension traits, feature flags, wire shapes, and endpoint parameters, use the advanced reference path.