Mihaela Mihaljevic
0f3086c8e6
Follow the mihaela-agents mermaid rule: add a README roadmap using the TileDown Apple-color status classes (done/review/epic/todo), legend block first, then a libxml2-parity roadmap showing shipped vs open work. Add docs/rules/mermaid.md and scripts/check-roadmap.sh (wired into check-all.sh) so the diagrams stay mechanically checkable.
52 lines
1.7 KiB
Markdown
52 lines
1.7 KiB
Markdown
# Mermaid Rules
|
|
|
|
## Rule 1: Use the TileDown Mermaid palette
|
|
|
|
Every Mermaid roadmap diagram in this repository must use TileDown's Mermaid
|
|
status classes and exact colors.
|
|
|
|
```mermaid
|
|
flowchart TB
|
|
classDef done fill:#ddf9e4,stroke:#34c759,color:#111827
|
|
classDef review fill:#fff7d6,stroke:#ffcc00,color:#111827
|
|
classDef epic fill:#f2e5ff,stroke:#af52de,color:#111827
|
|
classDef todo fill:#f2f4f7,stroke:#8e8e93,color:#111827
|
|
Done["In main now"]:::done
|
|
Review["PR in review"]:::review
|
|
Epic["Epic grouping"]:::epic
|
|
Todo["Open issue, no PR"]:::todo
|
|
Done ~~~ Review
|
|
Review ~~~ Epic
|
|
Epic ~~~ Todo
|
|
```
|
|
|
|
Allowed classes:
|
|
|
|
- `done`: merged or shipped work
|
|
- `review`: pull request in review
|
|
- `epic`: grouping issue or roadmap parent
|
|
- `todo`: open work with no PR
|
|
|
|
Do not add ad-hoc Mermaid status colors. Add a new class only after TileDown's
|
|
Mermaid palette adds the same class.
|
|
|
|
## Rule 2: Keep roadmap Mermaid mechanically checkable
|
|
|
|
Roadmap Mermaid blocks must keep `classDef` lines before nodes and edges. Every
|
|
node must use one of the allowed classes, and every edge must reference nodes
|
|
already defined in that block.
|
|
|
|
The README must start its Mermaid section with the shared legend. Run
|
|
`bash scripts/check-roadmap.sh` after changing roadmap diagrams.
|
|
|
|
## Rule 3: Collapse completed epics
|
|
|
|
Completed epics must not be expanded into their child issues in Mermaid
|
|
roadmaps. Once every child in an epic is `done`, remove that detailed Mermaid
|
|
block and show the completed epic as one `done` node in its parent or
|
|
super-epic roadmap.
|
|
|
|
Do not keep all-green detailed roadmap diagrams. The issue checklist can retain
|
|
the historical child issue list, but Mermaid must stay focused on active or
|
|
upcoming work.
|