Skip to content

Reading paths

Pick the track that matches what you are trying to do.

I just want to run it (CLI)

  1. docs/user/usage.md
  2. docs/overview/concepts.md (mental model + artifacts)
  3. docs/spec/execution_artifacts.md (what files are produced and what they mean)

I want to embed it (HTTP API)

  1. docs/api/index.md
  2. docs/spec/system_contract.md
  3. docs/spec/execution_contracts.md
  4. docs/spec/failure_model.md

I want the formal guarantees (spec)

  1. docs/spec/read_this_first.md
  2. docs/spec/system_contract.md
  3. docs/spec/execution_guarantees.md
  4. docs/spec/execution_artifacts.md
  5. docs/spec/failure_model.md and docs/spec/failure_semantics.md
  6. docs/spec/invariants/*

I maintain the repository

  1. docs/maintainer/spec.md (entry point)
  2. docs/maintainer/tooling.md (commands + CI expectations)
  3. docs/maintainer/testing.md
  4. docs/maintainer/documentation-invariant.md