Reading paths¶
Pick the track that matches what you are trying to do.
I just want to run it (CLI)¶
docs/user/usage.mddocs/overview/concepts.md(mental model + artifacts)docs/spec/execution_artifacts.md(what files are produced and what they mean)
I want to embed it (HTTP API)¶
docs/api/index.mddocs/spec/system_contract.mddocs/spec/execution_contracts.mddocs/spec/failure_model.md
I want the formal guarantees (spec)¶
docs/spec/read_this_first.mddocs/spec/system_contract.mddocs/spec/execution_guarantees.mddocs/spec/execution_artifacts.mddocs/spec/failure_model.mdanddocs/spec/failure_semantics.mddocs/spec/invariants/*
I maintain the repository¶
docs/maintainer/spec.md(entry point)docs/maintainer/tooling.md(commands + CI expectations)docs/maintainer/testing.mddocs/maintainer/documentation-invariant.md