golem15/summercms
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(11.1-03): update state, roadmap and requirements after plan 03

Browse Source
This commit is contained in:
Jakub Zych
2026-09-30 22:18:45 +02:00
parent 3131d7f3e1
commit 4d7823984e
3 changed files with 18 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
.planning/REQUIREMENTS.md
View File

@@ -125,12 +125,12 @@ Requirements for v1 (the Płytarium port). Each maps to roadmap phases. "User" b
### 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
- [x] **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
- [x] **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
- [x] **DOCS-04**: Every Go fence in a `docs/` page references compiled source by `src=` (Go fences in ingested module READMEs are identifier-checked only, per D-18); a test fails on a missing or drifted snippet, and referenced Examples carry `// Output:` and run under `go test ./...`
- [x] **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
- [x] **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
- [x] **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
@@ -243,12 +243,12 @@ 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-01 | Phase 11.1 | Complete |
| DOCS-02 | Phase 11.1 | Complete |
| DOCS-03 | Phase 11.1 | Pending |
| DOCS-04 | Phase 11.1 | Complete |
| DOCS-05 | Phase 11.1 | Complete |
| DOCS-06 | Phase 11.1 | Pending |
| DOCS-06 | Phase 11.1 | Complete |
| DOCS-07 | Phase 11.1 | Pending |
| DOCS-08 | Phase 11.1 | Complete |

6
.planning/ROADMAP.md
View File

@@ -544,7 +544,7 @@ Plans:
4. Every Go example in a `docs/` page is compiled and run by `go test ./...` (Go code in ingested module READMEs is identifier-checked, not compiled — D-18). An identifier checker and an internal link/anchor checker also run there and fail on stale names or broken links.
5. A "Coming from WinterCMS" concept map and an `acme/blog` porting walkthrough exist, and the walkthrough's code is verified under criterion 4.
**Plans:** 2/6 plans executed
**Plans:** 3/6 plans executed
Plans:
**Wave 1**
@@ -554,7 +554,7 @@ Plans:
- [x] 11.1-02-PLAN.md — Accuracy gates (identifiers, links/anchors, command names, forbidden names, go-fence policy), UI-SPEC theme with chroma/v2, search, dark mode, `summer docs:serve`, phase gate, CLAUDE.md D-13 rule
**Wave 3** *(blocked on Wave 2 completion)*
- [ ] 11.1-03-PLAN.md — Content A: Setup (incl. Coming from WinterCMS), Architecture, Plugins, Console, module Examples
- [x] 11.1-03-PLAN.md — Content A: Setup (incl. Coming from WinterCMS), Architecture, Plugins, Console, module Examples
**Wave 4** *(blocked on Wave 3 completion)*
- [ ] 11.1-04-PLAN.md — Content B: Database, Backend, Services (jobs, realtime, push, search, parity, transactions), Frontend and AJAX (not provided), module Examples
@@ -674,7 +674,7 @@ Phases execute in numeric order: 1 → 2 → 3 → 4 → 5 → 6 → 7 → 8 →
| 9. Backend admin authentication and schema pipeline | 12/12 | In Progress| |
| 10. Admin Vue SPA | 5/5 | Complete | 2026-09-27 |
| 11. Jobs, realtime and search infrastructure | 8/8 | In Progress| |
| 11.1. SummerCMS documentation for humans and AI agents | 2/6 | In Progress| |
| 11.1. SummerCMS documentation for humans and AI agents | 3/6 | In Progress| |
| 11.2. Ready to share: summercms.io website and newsletter plugin | 0/TBD | Not started | - |
| 12. Płytarium API — Collections and Albums | 0/TBD | Not started | - |
| 13. Płytarium API — wishlist, notifications, CSV, credentials, public routes | 0/TBD | Not started | - |

18
.planning/STATE.md
View File

@@ -4,16 +4,16 @@ milestone: v1.0
current_phase: "11.1"
current_phase_name: SummerCMS documentation for humans and AI agents (INSERTED)
status: executing
stopped_at: Completed 11.1-02-PLAN.md
last_updated: "2026-09-30T20:00:38.713Z"
stopped_at: Completed 11.1-03-PLAN.md
last_updated: "2026-09-30T20:18:25.664Z"
last_activity: 2026-09-30
last_activity_desc: Phase 11.1 execution started
state_head: dd11bdb0c7443b69cb1df3df4574fa6a8024cdb8
state_head: 3131d7f3e1bf26765fd71fbbb04201d5d5d6c115
progress:
total_phases: 19
completed_phases: 9
total_plans: 92
completed_plans: 88
completed_plans: 89
milestone_name: milestone
---
@@ -29,7 +29,7 @@ See: .planning/PROJECT.md (updated 2026-09-16)
## Current Position
Phase: 11.1 (SummerCMS documentation for humans and AI agents (INSERTED)) — EXECUTING
Plan: 3 of 6
Plan: 4 of 6
Status: Ready to execute
Last activity: 2026-09-30 — Phase 11.1 execution started
@@ -143,6 +143,7 @@ Progress: [██████░░░░] 60%
| Phase 11 P08 | unknown (manual close-out) | 3 tasks | 13 files |
| Phase 11.1 P01 | 15min | 3 tasks | 18 files |
| Phase 11.1 P02 | 30min | 3 tasks | 53 files |
| Phase 11.1 P03 | 15min | 3 tasks | 28 files |
## Accumulated Context
@@ -393,6 +394,9 @@ Recent decisions affecting current work:
- [Phase 11.1]: 11.1-02: The identifier index resolves promoted members itself; go doc does not resolve embedding and stays only as the fallback
- [Phase 11.1]: 11.1-02: docsCommands() collects app command names from the real constructors on backpack.New(&compass.Config{}); TestDocsCommandsMirrorGeneratedMain keeps it in step with internal/build
- [Phase 11.1]: 11.1-02: chroma/v2 v2.27.0 is the only new direct dependency (D-15); tokens map onto tok-* classes without chroma's HTML formatter
- [Phase 11.1]: 11.1-03: the Plugin.php-in-Go section shows modules/party/example_plugin_test.go as a whole-file src= fence because Go methods cannot live in an Example body
- [Phase 11.1]: 11.1-03: docs pages never carry hand-written Go fences; where no runnable Example fits, the page uses prose
- [Phase 11.1]: 11.1-03: bonfire has no duplicate command name check; documented as is and logged as todo bonfire-duplicate-command-names
### Pending Todos
@@ -423,6 +427,6 @@ Items acknowledged and carried forward from previous milestone close:
## Session Continuity
Last session: 2026-09-30T20:00:38.048Z
Stopped at: Completed 11.1-02-PLAN.md
Last session: 2026-09-30T20:18:25.015Z
Stopped at: Completed 11.1-03-PLAN.md
Resume file: None