docs(11.1): record plan-count checkpoint decisions, DOCS requirements and pattern map
This commit is contained in:
@@ -123,6 +123,17 @@ Requirements for v1 (the Płytarium port). Each maps to roadmap phases. "User" b
|
||||
- [x] **QA-04**: The first vertical slice (GET /_fonoteka/api/v1/genres) passes the parity diff end to end before further kernel abstraction
|
||||
- [ ] **QA-05**: Cutover: the parity harness is green on all 154 routes and vue-fonoteka-app and fonoteka-mcp run unchanged against the Go backend
|
||||
|
||||
### Documentation (DOCS)
|
||||
|
||||
- [ ] **DOCS-01**: `docs/` holds Markdown pages with strict YAML frontmatter (title, description, section, order), grouped into the Winter-mirroring sections, and every framework module under `modules/` is reachable from the sidebar through an API reference page ingested from its README
|
||||
- [ ] **DOCS-02**: `summer docs:build` writes a self-contained static site (sidebar, on-page TOC, prev/next, edit-this-page link, client-side search, light/dark/system theme) and `summer docs:serve` previews it on loopback; no Node toolchain, and the only new dependency is `alecthomas/chroma/v2` for syntax highlighting (approved at the 11.1 plan-count checkpoint)
|
||||
- [ ] **DOCS-03**: The build emits `llms.txt`, `llms-full.txt` and a clean `.md` beside every `.html` page, and a test asserts all three match the page tree
|
||||
- [ ] **DOCS-04**: Every Go fence in the docs references compiled source by `src=`; a test fails on a missing or drifted snippet, and referenced Examples carry `// Output:` and run under `go test ./...`
|
||||
- [ ] **DOCS-05**: `go test ./...` runs checkers that fail on stale identifiers (docs pages and module READMEs), broken internal links and anchors, unknown `summer`/runtime CLI command names and forbidden consuming-application names
|
||||
- [ ] **DOCS-06**: A "Coming from WinterCMS" page maps Winter concepts to SummerCMS equivalents, and every SummerCMS identifier on it is checker-verified
|
||||
- [ ] **DOCS-07**: An `acme/blog` porting walkthrough covers models, migrations, routes, an admin controller and a console command; its code is a real in-root package under `docs/examples/blog`, verified by DOCS-04
|
||||
- [ ] **DOCS-08**: CLAUDE.md's Documentation section records that API, config or CLI changes update both the module README and the affected docs pages, and names the automated checkers
|
||||
|
||||
## v2 Requirements
|
||||
|
||||
Deferred to a later milestone. Tracked but not in the current roadmap.
|
||||
@@ -232,12 +243,20 @@ Which phases cover which requirements. Updated during roadmap creation.
|
||||
| QA-03 | Phase 2 | Complete |
|
||||
| QA-04 | Phase 3 | Complete |
|
||||
| QA-05 | Phase 15 | Pending |
|
||||
| DOCS-01 | Phase 11.1 | Pending |
|
||||
| DOCS-02 | Phase 11.1 | Pending |
|
||||
| DOCS-03 | Phase 11.1 | Pending |
|
||||
| DOCS-04 | Phase 11.1 | Pending |
|
||||
| DOCS-05 | Phase 11.1 | Pending |
|
||||
| DOCS-06 | Phase 11.1 | Pending |
|
||||
| DOCS-07 | Phase 11.1 | Pending |
|
||||
| DOCS-08 | Phase 11.1 | Pending |
|
||||
|
||||
**Coverage:**
|
||||
- v1 requirements: 77 total
|
||||
- Mapped to phases: 77
|
||||
- v1 requirements: 85 total
|
||||
- Mapped to phases: 85
|
||||
- Unmapped: 0 ✓
|
||||
|
||||
---
|
||||
*Requirements defined: 2026-09-16*
|
||||
*Last updated: 2026-09-28 after adding ADMIN-07 (Phase 10.1 runtime admin extension point); previously 2026-09-16 after roadmap revision (15 phases, split former Phase 13 into Phase 11 jobs/realtime/search infrastructure and Phase 14 domain jobs/integrations, reordered before the API phases; 100% coverage)*
|
||||
*Last updated: 2026-09-30 after adding DOCS-01..08 (Phase 11.1 documentation); previously 2026-09-28 after adding ADMIN-07 (Phase 10.1 runtime admin extension point); previously 2026-09-16 after roadmap revision (15 phases, split former Phase 13 into Phase 11 jobs/realtime/search infrastructure and Phase 14 domain jobs/integrations, reordered before the API phases; 100% coverage)*
|
||||
|
||||
Reference in New Issue
Block a user