Documentation¶
This is the reference set for chipping-orchestrator, the layer under the project README. The README is the operator's end-to-end guide — install, configure, run, and the labels you drive an issue with. The reference explains why the system is shaped this way, which module owns what, what every setting does, and what each stage handler reads and writes.
Where to start¶
| If you want to… | Read |
|---|---|
| install with pipx | the quick start, then basic setup |
| run from source or launch developer analytics tools | the developer guide |
| understand the design before changing it | architecture.md |
| know what a label means, or when it moves | state-machine.md |
| know which agent a stage spawns, under what prompt | workflow.md |
find a setting, or apply an edited .env |
configuration.md |
| run a second poller beside the first on one host | running more than one poller |
| see what the orchestrator did, and what it cost | observability.md |
| trace release functionality and upgrade requirements | release-timeline.md |
| publish a release | maintainer notes |
| harden the deployment | security.md |
| report a suspected vulnerability | ../SECURITY.md |
| report a bug, propose a change, or contribute a PR | ../CONTRIBUTING.md |
| change the code | ../AGENTS.md, then the develop skill |
| size or split an issue | the decompose skill |
| preview or publish this documentation | publishing the documentation |
Every page¶
Grouped the way the site's navigation groups them.
- Operate — settings, operations, snapshot capability check, security
- How it works
- Architecture — overview, platform modules, workflow modules, observability modules
- State machine — overview, labels and state, delivery stages, conversation stages, lifecycle
- Agents — overview, agent roles, conversations, command specs
- Observability — overview, settings, event streams, trajectories, analytics database, analytics dashboard, usage parser
- Releases — release timeline
- Developers — source checkouts and tools