Choose a reading path
The book retains four Diátaxis sections because each serves a different kind of work: the tutorial teaches through a sequence, the guides give procedures, the concepts explain the model, and the reference pages record exact contracts. The paths below cross those sections without merging their functions.
Beginner: resolve and validate a record
Start with Install the CLI and fetch a lens. It produces a concrete result with the checked-out CLI, then points to Validate a typed record. Continue through the tutorial only when you want to apply and verify a lens or publish a recommendation.
Intermediate: integrate a project
Begin with the task closest to your project:
- Run codegen to derive Rust and TypeScript surfaces from a Lexicon family.
- Author a community vocabulary to add governed, machine-readable terms.
- Publish and resolve a lens to put a translation on the network.
- Index a firehose to consume repository events.
- Run the orchestrator HTTP API to query indexed records.
Use the corresponding crate, Lexicon, CLI, or HTTP API page when implementation work requires an exact signature or wire contract.
Advanced: extend or analyze the system
Read Lens semantics and laws before changing lens execution or verification, and read The vocabulary knowledge graph before extending vocabulary inference. The Observer protocol and Lexicon evolution policy connect those formal objects to runtime behavior. Then use the crate reference to find extension traits and the stability policy to decide which contracts downstream code may rely on.