Story: Documentation and diagrams
This page documents a story in Sprint 05. It captures the goal, current status, acceptance criteria, and the tasks that compose it.
Goal
Refresh UML diagrams after the entity-first reshape and the merged currency-messages work. Link every component model to its PlantUML diagram so org-roam navigation picks them up.
Status
| Field | Value |
|---|---|
| State | DONE |
| Parent sprint | Sprint 05 |
| Now | Completed 2025-12-01. |
| Waiting on | None. |
| Next | None. |
| Last touched | 2025-12-01 |
Acceptance
ores.cli,ores.shell,ores.refdata,ores.commsdiagrams reflect this sprint's structural changes.- Each component model has an inline id-link / file-link to its PlantUML diagram.
Tasks
| Task | State | Start | End | Description |
|---|---|---|---|---|
| Update all UML diagrams after shell changes | DONE | 2025-12-01 | 2025-12-01 | Refresh per-component UML diagrams to reflect the entity-first CLI restructure and merged currency messages. |
| Add links to UML diagrams | DONE | 2025-12-01 | 2025-12-01 | Each component model now links to its PlantUML diagram from the org-roam graph. |
Decisions
- Diagrams travel with the code
- per-component
.pumlsources live underprojects/<comp>/modeling/, regenerated bymad.
See also
- How do I generate PlantUML diagrams? — recipe.
- Documentation infrastructure (sprint 01) and Documentation polish (sprint 04) — predecessor doc stories.