Anolis Documentation

Welcome to the 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. decoupling.md - The ecosystem model and the invariant every change is tested against.
4. system-surfaces.md - Boundary & ownership map of every external surface (org-wide).
5. configuration.md - How to author and validate runtime YAML.
6. http-api.md - Human guide for runtime /v0 HTTP usage.

Deployment

1. deploy/README.md - One provisioning engine, and the routes to it.
2. deploy/install-sh.md - Canonical headless deploy, online or offline.
3. deploy/workbench-ssh.md - Provision a remote machine over SSH.
4. deploy/developer.md - Running a locally built runtime on a rig.

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.
5. rfcs/provider-declared-safe-state.md - Accepted-with-revisions design for provider-owned safe state.
6. rfcs/stop-chain.md - Proposed: observing the emergency stop, and the reset that follows it.

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.