flowchart TD A["Canonical Markdown, JSON, schemas, policies"] --> G["Deterministic reference generator"] G --> C["Curated tutorials + exhaustive indexes"] C --> Q["Quarto render"] Q --> V["Offline completeness, links, metadata, accessibility"] V --> B["Real-browser responsive and keyboard checks"] B --> P["Commit-bound GitHub Pages artifact"] P --> D["Post-deploy public attestation"]
How to use the GenesisCode documentation
A map of the human learning spine, agent retrieval spine, exhaustive indexes, and canonical authorities.
Choose the smallest trustworthy path
GenesisCode publishes one corpus through several views. The views are optimized for different jobs, but they do not have equal authority. Tutorials explain. Generated references enumerate. Specifications, schemas, policies, and executable checks define the contract.
ImportantAuthority rule
When a curated explanation and a canonical source disagree, the canonical source wins. Treat the mismatch as a documentation defect and report it through the page’s Edit, Source, or Issue action.
If you are learning the language
Read the curated spine in dependency order:
- Quickstart builds the pinned CLI and evaluates one pure module.
- Language tour introduces data, functions, modules, contracts, and types.
- Effects and replay moves host interaction beyond the pure kernel.
- Packages and testing binds modules, policy, limits, obligations, and evidence.
- Agent loop explains bounded retrieval and safe automated repair.
Use the task-oriented guides after the language model is clear. Use search or the exhaustive reference when you know the identity you need.
If you are an agent
Do not load the complete site into context. Use the bounded retrieval spine:
llms.txt
-> compact core card
-> exactly one task card
-> exact symbol or diagnostic lookup
-> canonical source anchor
-> executable validation- Start with
llms.txtor the agent onboarding spine. - Load
GC_AGENT_CORE_CARD_v0.3. - Select exactly one task card.
- Resolve exact symbols and diagnostics through
genesis agent-index. - Expand into a canonical authority only when the compact record points there.
- Return validation commands, input identities, output hashes, diagnostics, and unresolved gaps.
If no task card matches, fail closed. Retrieve the authoring bundle instead of inventing a workflow.
If you are verifying a claim
Start from the claim surface and walk toward stronger evidence:
| Question | First view | Contract authority |
|---|---|---|
| Is this feature usable? | Feature matrix | Capability evidence ledger and owning specification |
| What does this symbol do? | Symbol reference | Frozen profile, source anchor, and conformance tests |
| Why did a command fail? | Diagnostic reference | Diagnostic catalog, JSON schema, and producer tests |
| Can this host operation run? | Capability reference | Host ABI, capability policy, runner, and replay checks |
| Is a release statement current? | Changelog | Generated release notes and exact-revision CI evidence |
| Is future work implemented? | Roadmap | Checked task state and cited acceptance evidence |
The publication pipeline
The generated site records its source commit, source tree state, reference-index digest, and whole-artifact digest in build-metadata.json. Publication checks the live Pages deployment against that exact commit.