Files
summercms/.planning/todos/pending/per-module-readmes-after-nest.md
2026-09-28 01:27:19 +02:00

15 lines
673 B
Markdown

---
title: Short README.md per modules/* after the nest
date: 2026-09-28
priority: medium
area: summercms.go/modules
---
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.