Skip to content

Commit 92504e2

Browse files
committed
docs(sysprom): record decision and change for Mermaid click directives
DEC51 + CHG49: Add click directive support with anchor-based links for embedded diagrams and external-reference-based links for standalone graph output
1 parent a352079 commit 92504e2

3 files changed

Lines changed: 50 additions & 0 deletions

File tree

.SysProM.json

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4068,6 +4068,32 @@
40684068
"src/endpoint-types.ts"
40694069
],
40704070
"type": "change"
4071+
},
4072+
{
4073+
"context": "Mermaid supports click directives that make diagram nodes into hyperlinks. SysProM generates diagrams in two contexts: embedded in Markdown and standalone. Users want clickable nodes to navigate documentation.",
4074+
"id": "DEC51",
4075+
"name": "Mermaid click directives for diagram hyperlinks",
4076+
"options": [
4077+
{
4078+
"description": "Add click directives with two modes — anchor-based for embedded diagrams and external-reference-based for standalone",
4079+
"id": "OPT-A"
4080+
},
4081+
{
4082+
"description": "Always link to external references only",
4083+
"id": "OPT-B"
4084+
}
4085+
],
4086+
"rationale": "Anchor-based links provide the best UX for embedded diagrams since clicking navigates directly to the node definition. External reference links serve standalone use cases.",
4087+
"selected": "OPT-A",
4088+
"type": "decision"
4089+
},
4090+
{
4091+
"id": "CHG49",
4092+
"name": "Implement Mermaid click directive support",
4093+
"scope": [
4094+
"src/operations/graph-shared.ts,src/operations/graph.ts,src/json-to-md.ts,src/cli/commands/graph.ts,src/cli/commands/json2md.ts"
4095+
],
4096+
"type": "change"
40714097
}
40724098
],
40734099
"relationships": [
@@ -5235,6 +5261,11 @@
52355261
"from": "CHG48",
52365262
"to": "DEC50",
52375263
"type": "implements"
5264+
},
5265+
{
5266+
"from": "CHG49",
5267+
"to": "DEC51",
5268+
"type": "implements"
52385269
}
52395270
]
52405271
}

.SysProM/CHANGES.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -819,3 +819,10 @@ Scope:
819819
Scope:
820820
- src/endpoint-types.ts
821821

822+
### CHG49 — Implement Mermaid click directive support
823+
824+
- Implements: [DEC51](./DECISIONS.md#dec51--mermaid-click-directives-for-diagram-hyperlinks)
825+
826+
Scope:
827+
- src/operations/graph-shared.ts,src/operations/graph.ts,src/json-to-md.ts,src/cli/commands/graph.ts,src/cli/commands/json2md.ts
828+

.SysProM/DECISIONS.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -994,3 +994,15 @@ Chosen: OPT-A
994994

995995
Rationale: Extending existing relationship types is more consistent, leverages semantic meaning already defined, and provides maximum expressivity without introducing new abstractions.
996996

997+
### DEC51 — Mermaid click directives for diagram hyperlinks
998+
999+
Context: Mermaid supports click directives that make diagram nodes into hyperlinks. SysProM generates diagrams in two contexts: embedded in Markdown and standalone. Users want clickable nodes to navigate documentation.
1000+
1001+
Options:
1002+
- OPT-A: Add click directives with two modes — anchor-based for embedded diagrams and external-reference-based for standalone
1003+
- OPT-B: Always link to external references only
1004+
1005+
Chosen: OPT-A
1006+
1007+
Rationale: Anchor-based links provide the best UX for embedded diagrams since clicking navigates directly to the node definition. External reference links serve standalone use cases.
1008+

0 commit comments

Comments
 (0)