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

docs(11.1-05): record plan 05 progress in state, roadmap and requirements

Browse Source
This commit is contained in:
Jakub Zych
2026-09-30 23:44:10 +02:00
parent 0223e39b2c
commit 4c68d31862
3 changed files with 16 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.planning/REQUIREMENTS.md
View File

@@ -131,7 +131,7 @@ Requirements for v1 (the Płytarium port). Each maps to roadmap phases. "User" b
- [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-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 - [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
- [x] **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-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 - [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
## v2 Requirements ## v2 Requirements
@@ -249,7 +249,7 @@ Which phases cover which requirements. Updated during roadmap creation.
| DOCS-04 | Phase 11.1 | Complete | | DOCS-04 | Phase 11.1 | Complete |
| DOCS-05 | Phase 11.1 | Complete | | DOCS-05 | Phase 11.1 | Complete |
| DOCS-06 | Phase 11.1 | Complete | | DOCS-06 | Phase 11.1 | Complete |
| DOCS-07 | Phase 11.1 | Pending | | DOCS-07 | Phase 11.1 | Complete |
| DOCS-08 | Phase 11.1 | Complete | | DOCS-08 | Phase 11.1 | Complete |
**Coverage:** **Coverage:**

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. 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. 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:** 4/6 plans executed **Plans:** 5/6 plans executed
Plans: Plans:
**Wave 1** **Wave 1**
@@ -560,7 +560,7 @@ Plans:
- [x] 11.1-04-PLAN.md — Content B: Database, Backend, Services (jobs, realtime, push, search, parity, transactions), Frontend and AJAX (not provided), module Examples - [x] 11.1-04-PLAN.md — Content B: Database, Backend, Services (jobs, realtime, push, search, parity, transactions), Frontend and AJAX (not provided), module Examples
**Wave 5** *(blocked on Wave 4 completion)* **Wave 5** *(blocked on Wave 4 completion)*
- [ ] 11.1-05-PLAN.md — acme/blog porting walkthrough under docs/examples/blog with Docker and scaffold-layout tests - [x] 11.1-05-PLAN.md — acme/blog porting walkthrough under docs/examples/blog with Docker and scaffold-layout tests
**Wave 6** *(blocked on Wave 5 completion)* **Wave 6** *(blocked on Wave 5 completion)*
- [ ] 11.1-06-PLAN.md — Unit tests last: planted-violation fixtures, internal/docsite coverage, SC1-SC5 acceptance, final gate, validated VALIDATION.md - [ ] 11.1-06-PLAN.md — Unit tests last: planted-violation fixtures, internal/docsite coverage, SC1-SC5 acceptance, final gate, validated VALIDATION.md
@@ -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| | | 9. Backend admin authentication and schema pipeline | 12/12 | In Progress| |
| 10. Admin Vue SPA | 5/5 | Complete | 2026-09-27 | | 10. Admin Vue SPA | 5/5 | Complete | 2026-09-27 |
| 11. Jobs, realtime and search infrastructure | 8/8 | In Progress| | | 11. Jobs, realtime and search infrastructure | 8/8 | In Progress| |
| 11.1. SummerCMS documentation for humans and AI agents | 4/6 | In Progress| | | 11.1. SummerCMS documentation for humans and AI agents | 5/6 | In Progress| |
| 11.2. Ready to share: summercms.io website and newsletter plugin | 0/TBD | Not started | - | | 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 | - | | 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 | - | | 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: "11.1"
current_phase_name: SummerCMS documentation for humans and AI agents (INSERTED) current_phase_name: SummerCMS documentation for humans and AI agents (INSERTED)
status: executing status: executing
stopped_at: Completed 11.1-04-PLAN.md stopped_at: Completed 11.1-05-PLAN.md
last_updated: "2026-09-30T21:20:10.781Z" last_updated: "2026-09-30T21:44:00.677Z"
last_activity: 2026-09-30 last_activity: 2026-09-30
last_activity_desc: Phase 11.1 execution started last_activity_desc: Phase 11.1 execution started
state_head: 44bd1446f572c92b31e16f7f6153349614af2c12 state_head: 0223e39b2c651b75fcadff160ae593e416a1b285
progress: progress:
total_phases: 19 total_phases: 19
completed_phases: 9 completed_phases: 9
total_plans: 92 total_plans: 92
completed_plans: 90 completed_plans: 91
milestone_name: milestone milestone_name: milestone
--- ---
@@ -29,7 +29,7 @@ See: .planning/PROJECT.md (updated 2026-09-16)
## Current Position ## Current Position
Phase: 11.1 (SummerCMS documentation for humans and AI agents (INSERTED)) — EXECUTING Phase: 11.1 (SummerCMS documentation for humans and AI agents (INSERTED)) — EXECUTING
Plan: 5 of 6 Plan: 6 of 6
Status: Ready to execute Status: Ready to execute
Last activity: 2026-09-30 — Phase 11.1 execution started Last activity: 2026-09-30 — Phase 11.1 execution started
@@ -145,6 +145,7 @@ Progress: [██████░░░░] 60%
| Phase 11.1 P02 | 30min | 3 tasks | 53 files | | Phase 11.1 P02 | 30min | 3 tasks | 53 files |
| Phase 11.1 P03 | 15min | 3 tasks | 28 files | | Phase 11.1 P03 | 15min | 3 tasks | 28 files |
| Phase 11.1 P04 | 47min | 3 tasks | 68 files | | Phase 11.1 P04 | 47min | 3 tasks | 68 files |
| Phase 11.1 P05 | 18min | 3 tasks | 37 files |
## Accumulated Context ## Accumulated Context
@@ -401,6 +402,9 @@ Recent decisions affecting current work:
- [Phase 11.1]: 11.1-04: The transactions page follows lagoon at HEAD: nested lagoon.Transaction needs the outer tx, AfterCommit in a plain GORM transaction warns and skips - [Phase 11.1]: 11.1-04: The transactions page follows lagoon at HEAD: nested lagoon.Transaction needs the outer tx, AfterCommit in a plain GORM transaction warns and skips
- [Phase 11.1]: 11.1-04: Docs examples never register global drivers or engines; toy engines use test-only hooks and driver examples live in the driver package - [Phase 11.1]: 11.1-04: Docs examples never register global drivers or engines; toy engines use test-only hooks and driver examples live in the driver package
- [Phase 11.1]: 11.1-04: Database-bound docs snippets run as TestDocs* regions on each module's Postgres harness through export_docs_test.go wrappers - [Phase 11.1]: 11.1-04: Database-bound docs snippets run as TestDocs* regions on each module's Postgres harness through export_docs_test.go wrappers
- [Phase 11.1]: 11.1-05: acme.blog walkthrough lives in the root module (docs/examples/blog) and is pinned to make:* output by TestScaffoldLayout
- [Phase 11.1]: 11.1-05: console.PublishCommand takes a withDB parameter because generated zero-argument commands cannot reach the app; Plugin.Commands appends it
- [Phase 11.1]: 11.1-05: walkthrough form omits published_at (cabana has no date field type); blog:publish sets it and the list shows it
### Pending Todos ### Pending Todos
@@ -431,6 +435,6 @@ Items acknowledged and carried forward from previous milestone close:
## Session Continuity ## Session Continuity
Last session: 2026-09-30T21:20:10.227Z Last session: 2026-09-30T21:43:59.912Z
Stopped at: Completed 11.1-04-PLAN.md Stopped at: Completed 11.1-05-PLAN.md
Resume file: None Resume file: None