Story: PlantUML and modeling refresh
Table of Contents
This page documents a story in Sprint 17. It captures the goal, current status, acceptance criteria, and the tasks that compose it.
Goal
Add a script to generate PlantUML class diagrams for every component, bulk-refresh all existing component diagrams with the new script, and migrate all component_overview.org files to the v2 information architecture.
Status
| Field | Value |
|---|---|
| State | DONE |
| Parent sprint | Sprint 17 |
| Now | Completed 2026-05-20. |
| Waiting on | None. |
| Next | None. |
| Last touched | 2026-05-20 |
Acceptance
- All tasks complete; PR-by-PR breakdown in
git log.
Tasks
| Task | State | Start | End | Description |
|---|---|---|---|---|
| Task: Add component PlantUML generation script and bulk-refresh all diagrams | DONE | 2026-05-22 | 2026-05-22 | - Add `build/scripts/generate_component_puml.py`: a regex-based script that walks each project's `include/` headers and |
| Task: [modeling] Migrate all component docs to v2 information architecture | DONE | 2026-05-22 | 2026-05-22 | - Migrates all component documentation from the legacy stub format to the v2 information architecture (`component_overvi |
Decisions
- (none)
Out of scope
- Sequence diagrams and ER diagrams (have separate conventions docs).