35 lines
2.1 KiB
Markdown
35 lines
2.1 KiB
Markdown
# #830 Documentation Completion Checklist
|
|
|
|
## Required artifacts
|
|
|
|
- [x] `docs/PRD.md` contains the M1 compaction-refresh trust-lifecycle requirements and acceptance criteria.
|
|
- [x] Operator behavior and recovery are documented in `docs/guides/lease-broker-operations.md`.
|
|
- [x] Developer architecture and protocol behavior are documented in `docs/architecture/compaction-revocation.md`, `lease-broker-protocol.md`, and `mutator-class-gate.md`.
|
|
- [x] Security boundaries and residuals are documented in `docs/architecture/lease-broker-security.md` and `compaction-revocation.md`.
|
|
- [x] `docs/SITEMAP.md` links the new architecture page.
|
|
- [x] User-guide changes are not applicable: observers are mandatory internal runtime controls with no end-user workflow.
|
|
- [x] OpenAPI/endpoint changes are not applicable: the broker remains an internal Unix-socket protocol, not a public HTTP API.
|
|
|
|
## Contract coverage
|
|
|
|
- [x] Claude and Claudex lifecycle signals, matchers, commands, and fail-closed behavior are documented.
|
|
- [x] Pi pre-/post-compaction signals and session replacement reasons are documented.
|
|
- [x] Private generation-file ownership, monotonic update, same-PID replacement, and failure fencing are documented.
|
|
- [x] `revoke_lease` input purpose, broker response state, and denial behavior are documented.
|
|
- [x] T12b/T30 explicitly names the bounded residual stale window and reports within-TTL **ALLOWED** / after-TTL **DENIED**.
|
|
- [x] Documentation explicitly disclaims a within-window mutator-action bound.
|
|
- [x] T-A, T-C, same-principal, and protected-branch boundaries are retained.
|
|
|
|
## Structure and review
|
|
|
|
- [x] New architecture content is under `docs/architecture/`.
|
|
- [x] This report is under `docs/reports/compaction-refresh/`.
|
|
- [x] Session evidence is under `docs/scratchpads/`.
|
|
- [x] 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
|
|
|
|
- [x] Canonical documentation remains in-repository.
|
|
- [x] No external publishing target is required for this internal M1 control.
|