rqmd-diagrams

Files (1)

• SKILL.md

SKILL.md (first lines)

Use when creating, editing, or reviewing Mermaid diagrams in markdown.

## Validation

`mmdc` always writes SVGs — run from a temp directory to avoid polluting the repo:

```bash
pushd $(mktemp -d) && mmdc -i "$OLDPWD/<path/to/file.md>" 2>&1; popd
```

All charts must show ✅ before done. Install: `npm install -g @mermaid-js/mermaid-cli` (Node 18+).

> **🚨 Warning:** Never run `mmdc -i <file>` from inside the repo without the temp-dir wrapper.

## Syntax rules

| Rule | ✅ Correct | ❌ Wrong |
|------|-----------|----------|
| Line breaks | `A --> B : First<br>Second` | `A --> B : First\nSecond` |
| Node labels | `L[awaitingScorecardAccept = true]` | `L["CHOOSE then GO"]` (no `"` inside) |
| stateDiagram-v2 | `A --> B : implicit — no back handler` | `A --> B : (implicit: same handler)` (no second `:`) |

### Notes in stateDiagram-v2

```
note right of StateName
    Free-form text here
end note
```

## Diagram types

| Type | Keyword | Best for |
|------|---------|----------|
| State machine | `stateDiagram-v2` | Boolean flags, mode transitions, lifecycle |
| Flow | `flowchart TD/LR` | Execution paths, call chains, save/restore |

## Checklist

- [ ] `<br>` for label line breaks (no `\n`)
- [ ] No `"` inside node labels
- [ ] No second `:` in stateDiagram-v2 transitions
- [ ] `mmdc -i <file>` exits 0 with all ✅
- [ ] VS Code Mermaid preview renders without errors

From ryeleo/rqmd-vscode, MIT.

More from ryeleo/rqmd-vscode