You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: workflows/agentic-wiki-writer.md
+14-1Lines changed: 14 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -493,6 +493,13 @@ Diagram type by use case: `flowchart LR` for architecture/data flow; `sequenceDi
493
493
494
494
Syntax rules: Always specify direction (`LR` or `TD`). Wrap labels containing special characters in double quotes: `A["MyClass::method()"]`. One relationship per line. Use subgraphs sparingly (max one level deep). Add a brief sentence before the diagram explaining what it shows.
495
495
496
+
**Critical mermaid restrictions** — GitHub's renderer is strict. Violating these causes "Unable to render rich display" errors:
497
+
498
+
-**No backtick strings** — Do NOT use the backtick/markdown-string syntax inside node labels: `` A["`label`"] `` is invalid. Use plain text or double-quoted strings only: `A["label"]`.
499
+
-**No `\n` in labels** — Do NOT use `\n` escape sequences inside node labels. They are not rendered as newlines and cause lexer errors. Keep labels to a single line. If a label is too long, shorten it or split the node into two nodes.
500
+
-**No special characters unquoted** — Any label containing `@`, `(`, `)`, `:`, `/`, `<`, `>`, or other non-alphanumeric characters must be wrapped in double quotes.
501
+
-**Test mentally before writing** — Before including a diagram, verify each node label is either plain alphanumeric text or a properly double-quoted string with no escape sequences.
502
+
496
503
```mermaid
497
504
flowchart LR
498
505
A[Input] --> B[Process] --> C[Output]
@@ -576,7 +583,13 @@ Before finalizing each page, check for these issues and fix them:
576
583
577
584
5.**Accuracy** — Content matches what the source code actually does. No fabricated features or APIs.
578
585
579
-
6.**Structural consistency** — Similar sections across pages use the same structure and formatting patterns.
586
+
6.**Mermaid diagram syntax** — For every mermaid diagram, verify:
0 commit comments