Files
summercms/.planning/todos/done/per-module-readmes-after-nest.md
Jakub Zych 3f9d3b4f11 docs: sync todos with g15office and map phases to milestone tasks
Tag the 17 open todos with their g15office task IDs, close 7 todos that
are already done or promoted to Phase 16.3, and record the sync rules
and the phase-to-task map in .planning/G15OFFICE.md.
2026-10-11 02:01:50 +02:00

21 lines
826 B
Markdown

---
title: Short README.md per modules/* after the nest
date: 2026-09-28
priority: medium
area: summercms.go/modules
status: done
closed: 2026-10-11
---
Blocked on `.planning/todos/pending/nest-framework-packages-under-modules.md`.
After the packages live under `modules/`, spawn a GSD explore / researcher pass (one agent, not a hand-written dump) to write a short `README.md` in each `modules/<name>/`.
Each file: one paragraph on what the package is for, who imports it, and one example entry point (`Package.Type` or file). No architecture essays. No copy-paste of planning docs.
The top-level `summercms.go/README.md` should then link the directory instead of explaining every beach name inline.
## Closed 2026-10-11
Done: all 24 `modules/*` packages ship a README (Phase 10.2, later the Role and mnemonic passes).