Documentation
August 16, 2026 ยท View on GitHub
This index separates normative specifications, operator guidance, evidence, and historical records. Start with the short path that matches your task.
Get started
| Document | Use it for |
|---|---|
| Quickstart | Supported environment, npm or source setup, first run, resume, and effectiveness check |
| Configuration | Frozen profiles, limits, provider route, credentials, and state schemas |
| Troubleshooting | Fail-closed diagnoses and safe recovery |
Understand the system
| Document | Use it for |
|---|---|
| Architecture overview | Controller, proposer, builder, Loader, evaluator, and evidence flow |
| DSH integration | Source-verified Cordis and Loader contracts |
| DSH upstream policy | Accepted pin, latest compatibility channel, and promotion workflow |
| Research basis | Papers, prior systems, adopted mechanisms, and corrected assumptions |
| Architecture decisions | ADRs and trade-offs |
specs/00โspecs/07 | Normative product, architecture, candidate, algorithm, evaluation, safety, evidence, and gate contracts |
Operate and audit
| Document | Use it for |
|---|---|
| Operations | Stop, backup, restore, rollback, and uninstall |
| Evidence guide | What each receipt proves and does not prove |
| Terminal-Bench runbook | Harbor/TB integration and optional benchmark profiles |
| Project status | Current accepted state, quarantines, and claim boundaries |
Releases and migration
| Document | Use it for |
|---|---|
| v0.2 release gates | Current provider, effectiveness, and release acceptance |
| v0.2 migration | Renamed packages, CLI, protocols, paths, and predecessor evidence |
| Phase checklist | Completed and optional post-release work |
| Audit index | Versioned gate and incident evidence |
| Changelog | User-visible changes by release |
Document authority
When records conflict, use this precedence:
- frozen run manifest and content-addressed receipts;
- normative files in
specs/; - operational documents in
docs/; - README and historical discussion.
Historical audits intentionally retain predecessor names, paths, failures, and claim wording. Do not modernize them in place; add a successor record.