2.1 KiB
2.1 KiB
#830 Documentation Completion Checklist
Required artifacts
docs/PRD.mdcontains the M1 compaction-refresh trust-lifecycle requirements and acceptance criteria.- Operator behavior and recovery are documented in
docs/guides/lease-broker-operations.md. - Developer architecture and protocol behavior are documented in
docs/architecture/compaction-revocation.md,lease-broker-protocol.md, andmutator-class-gate.md. - Security boundaries and residuals are documented in
docs/architecture/lease-broker-security.mdandcompaction-revocation.md. docs/SITEMAP.mdlinks the new architecture page.- User-guide changes are not applicable: observers are mandatory internal runtime controls with no end-user workflow.
- OpenAPI/endpoint changes are not applicable: the broker remains an internal Unix-socket protocol, not a public HTTP API.
Contract coverage
- Claude and Claudex lifecycle signals, matchers, commands, and fail-closed behavior are documented.
- Pi pre-/post-compaction signals and session replacement reasons are documented.
- Private generation-file ownership, monotonic update, same-PID replacement, and failure fencing are documented.
revoke_leaseinput purpose, broker response state, and denial behavior are documented.- T12b/T30 explicitly names the bounded residual stale window and reports within-TTL ALLOWED / after-TTL DENIED.
- Documentation explicitly disclaims a within-window mutator-action bound.
- T-A, T-C, same-principal, and protected-branch boundaries are retained.
Structure and review
- New architecture content is under
docs/architecture/. - This report is under
docs/reports/compaction-refresh/. - Session evidence is under
docs/scratchpads/. - Documentation changes are in the same logical change set as code and tests.
- Independent exact-head code and Opus security reviews pending coordinator sequencing after the deterministic-main rebase gate.
Publishing
- Canonical documentation remains in-repository.
- No external publishing target is required for this internal M1 control.