The project README and release checklist are the authoritative user-facing docs. The public site summarizes repository material. Use this index to find current guidance, design work, and historical evidence.
| Need | Document |
|---|---|
| Set up the compiler and use the CLI | Project README |
| Look up language syntax and semantics | Language specification |
| Check implementation gaps and priorities | Status |
| Understand enforced safety checks and unfinished proof work | Compiler safety contract |
| Build, verify, and prepare release artifacts | Release checklist |
| Understand the trust boundary and report vulnerabilities | Security policy |
| Read release-facing changes | Changelog |
| Read runnable language examples | Examples |
| Learn the pipeline and module map | Architecture |
| Style the docs site | Design system |
The specification includes planned language features. Read its implementation qualifications together with Status. A design requirement or a passing example does not establish complete safety or backend coverage.
- Public docs index organizes the site by task.
- Compact agent index lists public Markdown pages.
- Full public corpus combines those pages.
- Agent usage documents fetch paths.
- Documentation maintenance describes how public summaries follow repository docs.
The full public corpus contains the site pages, not all repository research or
PDFs. Its source pages live in site/public/docs/. The site build regenerates
llms.txt and llms-full.txt from those pages.
The safety research index maps the research, rationale, source attributions, edge-case studies, and language comparisons. Start with the handoff for the design-work snapshot, then consult the decision record for acceptance and open questions. The comparative index maps per-language studies.
These records contain proposals and historical implementation assessments. Accepted design decisions are not proof that a feature has shipped. Compare them with Status and the compiler safety contract before implementation work.
- Decision ledger: user decisions for v1, including superseded research decisions.
- Delivery roadmap: the current todo list and repair waves.
- V1 plan: order of work, evidence requirements and open approval gates.
- Array programming proposal: preserved tensor, broadcasting, and accelerator sketches, not implemented syntax.
- Zig GPU support research: versioned device-compiler and host-API evidence, with local compile-only results.
- Memory plan: proposed automatic, compile-time memory management with value semantics.
- Plan research: advisory framework, hardware, language, memory and security reports, plus the memory audits and reviews.
A plan entry is not an implemented feature. Check Status for current behavior.
The audit index maps the dated reviews. Each records its own scope and verification limits. Historical passing gates do not override later counterexamples or establish that a finding remains unfixed.
Error analysis records an older 36-example compiler state. Its measurements are historical, not current verification results. Error catalog lists every current diagnostic code with stage, exit, span, trigger, and fix. Archive notes record earlier cleanup and the locations of archived tools.
The pointer syntax analysis remains as historical design material. Its proposed reference operators are not current A7 syntax. The six alternate renderings were removed on 2026-09-19 with user approval; git history retains them. Current reference syntax is documented in the specification and safety contract.
For changes over time, use git log -- README.md docs site/public/docs site/public/llms.txt site/public/llms-full.txt. Preserve each record's dates,
qualifications, and sources when citing it.