Start here when navigating docs/. Package-level status lives in
../PUBLIC_STATUS.md; release facts in
../CHANGELOG.md.
| Doc | Purpose |
|---|---|
| ARCHITECTURE.md | Layers, public surfaces, dependency direction |
| API_BOUNDARY.md | Module/surface ownership (machine-checked vs registry) |
| API_STABILITY_MATRIX.md | Export stability classification |
| API_COMPATIBILITY.md | 1.x facade/schema freeze, migration and deprecation policy |
| MIGRATING_TO_1.md | Concrete 0.16.11 to 1.0 migration and rollback guide |
| CONFORMANCE.md | Language-neutral v1 corpus and GovEngine/RExecOp runner ownership |
| ../PUBLISHING.md | Fail-closed review, Trusted Publisher, tag, public smoke and RC-window procedure |
| THREAT_MODEL.md | TCB, attacker model, trust boundaries and residual risks |
| SECURITY_GUARANTEES.md | Tested guarantees, binding table and explicit non-claims |
| DOWNSTREAM_IMPORT_MAP.md | RExecOp/Tecrax import inventory and migration posture |
| GOVERNANCE_REQUEST.md | Canonical G2-A request and approval binding |
| SCOPE_CAPABILITY_BINDINGS.md | Independent scope and capability inputs/decisions |
| GOVERNANCE_DECISION.md | Canonical G2-C evaluator and attempt-bound authorization |
| GOVENGINE_KERNEL_BOUNDARY.md | Kernel vs profile vs runtime vs SCLite |
| ROADMAP.md | Current 1.0 release-candidate line and near-term direction |
| VALIDATION.md | Active release and operator validation gate |
| Doc | Purpose |
|---|---|
| GOVERNED_RUNTIME_MVP_RUNBOOK.md | Operator chain and procedures |
| SECURITY_INTEGRATION.md | Required security evaluation order |
| RUNTIME_ADMISSION.md | RuntimeAdmissionResult, supervisor admission and supervisor explain (G2) |
| POLICY_ENGINE.md | govengine.policy MVP and policy explain/simulate (G1) |
| ADMISSION_POLICY.md | Admission/audit record validators |
| RECEIPT_BINDING.md | Runner receipt binding |
| EVIDENCE_REVIEW.md | Evidence/review chain + OODA receipt bounds |
| INSPECT_ONLY_ADMISSION_WORKFLOW.md | Read-only admission CLI |
| GUARDED_FRESH_RUNTIME_ADMISSION_EXAMPLE.md | Guarded-strict + replay-fresh example |
| RUNNER_SUPERVISION.md | Runner supervision + live-runner safety |
| LOCAL_SUBPROCESS_RUNNER_DECISION.md | Why no live subprocess runner ships |
| SCLITE_INTEGRATION.md | How GovEngine consumes SCLite |
| Doc | Module focus |
|---|---|
| ORCHESTRATOR_MODEL.md | govengine.orchestration |
| EVENT_MODEL.md | govengine.events |
| STATE_MACHINE.md | govengine.state_machine |
| CONTROL_MODEL.md | govengine.control |
| RUNTIME_SHELL.md | govengine.runtime_shell |
| DOMAIN_PROFILE_CONTRACT.md | govengine.profiles |
Planning contracts (GovTaskContract, GovPlanIntentContract, PlannerPort) are
documented under Planning-contracts core in API_BOUNDARY.md.
Historical material kept for audit evidence, not as the active gate:
| Doc | Contents |
|---|---|
| archive/VALIDATION_HISTORY.md | Per-release validation records |
| archive/ROADMAP_VERSION_HISTORY.md | Delivered 0.2.x–0.11.x milestones |
When docs disagree, trust scripts/validate_public_truth.py and the current
sections of VALIDATION.md over archived records.