docs(handover): add architecture map and takeover playbook

This commit is contained in:
2026-02-12 20:45:09 +01:00
parent 6b282ce56b
commit ec4f85e1d0
7 changed files with 247 additions and 5 deletions

11
TODO.md
View File

@@ -197,11 +197,11 @@ This file is the single source of truth for roadmap and delivery progress.
### Code Documentation And Handover
- [ ] [P1] Create architecture map per package/app (`what exists`, `why`, `how to extend`) for `@cms/db`, `@cms/content`, `@cms/crud`, `@cms/ui`, `apps/admin`, `apps/web`
- [ ] [P1] Add module-level ownership docs for auth, media, pages/navigation, commissions, announcements/news flows
- [ ] [P1] Document critical invariants (single owner rule, protected support user, registration policy gates, media storage key contract)
- [ ] [P1] Add “request lifecycle” docs for key flows (auth sign-in/up, media upload, page publish, commission status change)
- [ ] [P1] Add coding handover playbook: local setup, migration workflow, test strategy, branch/release process, common failure recovery
- [x] [P1] Create architecture map per package/app (`what exists`, `why`, `how to extend`) for `@cms/db`, `@cms/content`, `@cms/crud`, `@cms/ui`, `apps/admin`, `apps/web`
- [x] [P1] Add module-level ownership docs for auth, media, pages/navigation, commissions, announcements/news flows
- [x] [P1] Document critical invariants (single owner rule, protected support user, registration policy gates, media storage key contract)
- [x] [P1] Add “request lifecycle” docs for key flows (auth sign-in/up, media upload, page publish, commission status change)
- [x] [P1] Add coding handover playbook: local setup, migration workflow, test strategy, branch/release process, common failure recovery
- [ ] [P2] Add code-level diagrams (Mermaid) for service boundaries and data relationships
- [ ] [P2] Add route/action inventory for admin and public apps with linked source files
@@ -319,6 +319,7 @@ This file is the single source of truth for roadmap and delivery progress.
- [2026-02-12] Admin settings now manage public header banner (enabled/message/CTA), backed by `system_setting` and consumed by public layout rendering.
- [2026-02-12] Added owner/support invariant integration tests for auth guards (`apps/admin/src/lib/auth/server.test.ts`), covering protected-user deletion blocking and one-owner repair/promotion rules.
- [2026-02-12] Started admin form component tests with media upload behavior coverage (`apps/admin/src/components/media/media-upload-form.test.tsx`).
- [2026-02-12] Added code handover documentation baseline: architecture map, critical invariants, request lifecycles, and onboarding playbook under `docs/product-engineering/`.
## How We Use This File