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

DocumentUse it for
QuickstartSupported environment, npm or source setup, first run, resume, and effectiveness check
ConfigurationFrozen profiles, limits, provider route, credentials, and state schemas
TroubleshootingFail-closed diagnoses and safe recovery

Understand the system

DocumentUse it for
Architecture overviewController, proposer, builder, Loader, evaluator, and evidence flow
DSH integrationSource-verified Cordis and Loader contracts
DSH upstream policyAccepted pin, latest compatibility channel, and promotion workflow
Research basisPapers, prior systems, adopted mechanisms, and corrected assumptions
Architecture decisionsADRs and trade-offs
specs/00โ€“specs/07Normative product, architecture, candidate, algorithm, evaluation, safety, evidence, and gate contracts

Operate and audit

DocumentUse it for
OperationsStop, backup, restore, rollback, and uninstall
Evidence guideWhat each receipt proves and does not prove
Terminal-Bench runbookHarbor/TB integration and optional benchmark profiles
Project statusCurrent accepted state, quarantines, and claim boundaries

Releases and migration

DocumentUse it for
v0.2 release gatesCurrent provider, effectiveness, and release acceptance
v0.2 migrationRenamed packages, CLI, protocols, paths, and predecessor evidence
Phase checklistCompleted and optional post-release work
Audit indexVersioned gate and incident evidence
ChangelogUser-visible changes by release

Document authority

When records conflict, use this precedence:

  1. frozen run manifest and content-addressed receipts;
  2. normative files in specs/;
  3. operational documents in docs/;
  4. 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.