Skip to content

Anolis Documentation

Use this file as the canonical documentation index.

Start Here

  1. getting-started.md - Build, run, and first validation.
  2. architecture.md - Runtime architecture and subsystem boundaries.
  3. configuration.md - How to author and validate runtime YAML.
  4. http-api.md - Human guide for runtime /v0 HTTP usage.

Contracts and Schemas

  1. schemas/README.md - Machine-readable contract artifacts.
  2. contracts/README.md - Contract baselines and change policy.
  3. http/README.md - Runtime HTTP contract validation workflow.

Runtime Reference

  1. configuration-schema.md - Compact narrative map of schema sections.
  2. automation.md - Automation architecture, mode semantics, and operation.
  3. providers.md - Provider model and runtime interaction rules.
  4. safety.md - Safety boundaries and operational expectations.

Contributor Reference

  1. local-verification.md - Fast local verification workflow.
  2. dependencies.md - Dependency and toolchain expectations.
  3. cpp-documentation-standard.md - C++ doc style rules.
  4. CONTRIBUTING.md - Contributor workflow and repo policy.

Commissioning Tooling

System Composer and Workbench planning/contracts are maintained in anolis-workbench.

Local C++ API docs: run doxygen docs/Doxyfile from repo root.