docs: add README files to 9 crates and update verification plan (TODO-030,036)
Add purpose, architecture, and public API summary to each crate README following chanora_resolver pattern. Update verification master plan with new evidence sources and entry/exit criteria.
This commit is contained in:
@@ -1,9 +1,12 @@
|
||||
# Chanora Verification Master Plan
|
||||
|
||||
**Document status:** DV meeting baseline candidate
|
||||
**Date:** 2026-05-29
|
||||
**Date:** 2026-06-11
|
||||
**Applies to:** Chanora Rust workspace `0.2.0-beta.1`, Flutter app `0.3.0+100`, and current DV/release-candidate evidence
|
||||
**Primary upstream documents:** `docs/sysrs.md`, `docs/sysdes.md`, `docs/srs.md`, `docs/architecture/sad.md`, `docs/architecture/sdd.md`, `docs/implementation-status-2026-05-28.md`
|
||||
**Change log:**
|
||||
- 2026-05-29 — initial baseline
|
||||
- 2026-06-11 — refreshed evidence sources, added per-crate documentation evidence, updated CI capabilities
|
||||
|
||||
## 1. Purpose
|
||||
|
||||
@@ -46,6 +49,8 @@ No document in this pack may convert an implementation gap into a pass. Gaps mus
|
||||
| Rust crate tests and benches | Workspace tests plus audio benchmark harnesses | SWE.4/SWE.5 performance and component evidence |
|
||||
| `tools/windows-smoke.md` | Windows source-build smoke procedure | SYS.4/SWE.5 manual platform evidence when executed |
|
||||
| `docs/release/ios-build.md` | Unsigned iOS verification build note | Release and platform build evidence |
|
||||
| Per-crate README.md files | 10 crates with documented purpose, architecture, public API, and platform notes (chanora_core, chanora_protocol, chanora_state, chanora_audio, chanora_storage, chanora_cache, chanora_diagnostics, chanora_bridge, chanora_prefetch, chanora_resolver) | SDD traceability: each module's public surface and invariants are documented in-tree alongside the source |
|
||||
| `docs/verification/` | SWE.4/SWE.5/SWE.6/SYS.4 verification plans, traceability matrix, waiver register, release-readiness record | Full DV documentation pack |
|
||||
|
||||
## 5. Entry Criteria for DV Review
|
||||
|
||||
@@ -60,6 +65,7 @@ No document in this pack may convert an implementation gap into a pass. Gaps mus
|
||||
| Traceability summary available | Met by this pack | `docs/governance/traceability-matrix.md` |
|
||||
| Release decision record available | Met by this pack | `docs/release/release-readiness-go-nogo-record.md` |
|
||||
| Open gates represented as waivers or blockers | Met by this pack | `docs/release/dv-waiver-register.md` |
|
||||
| Per-crate documentation available | Met | README.md in each of 10 crate directories |
|
||||
|
||||
## 6. Exit Criteria for DV Meeting
|
||||
|
||||
@@ -72,6 +78,7 @@ The DV meeting can pass the documentation baseline if reviewers agree that:
|
||||
| Verification scope is honest | Known gaps are not marked as passed |
|
||||
| Waivers are explicit | Each release-affecting gap has owner, impact, mitigation, and unblock condition |
|
||||
| Release recommendation is clear | Current candidate is not represented as public-release-ready while DEC-012 and other gates remain open |
|
||||
| Module documentation is traceable | Each crate's README describes its actual purpose, architecture, and public API as built |
|
||||
|
||||
## 7. Open Gates Affecting Release
|
||||
|
||||
|
||||
Reference in New Issue
Block a user