Skip to content

NetFabric/NetFabric.Numerics / .agents/skills/mermaid-diagrams

mermaid-diagrams

Verified

Author Mermaid diagrams inside ```mermaid fenced code blocks in markdown files (README, AGENTS.md, PR descriptions, chat responses). Covers every stable, non-experimental diagram type: flowchart, sequence, class, state, entity relationship, user journey, Gantt, pie, quadrant, requirement, gitGraph, block, packet, kanban, XY chart, event modeling. Use when: picking a diagram type; writing correct fence syntax; documenting architecture, processes, timelines, schemas, or data relationships compactly for humans and agents alike, since a diagram conveys structure in far fewer tokens than prose. DO NOT USE FOR: the Mermaid Live Editor or mermaid.ai chat (fence syntax only); experimental or beta diagrams (swimlanes, mindmap, timeline, sankey, architecture, radar, treemap, venn, ishikawa, wardley, cynefin, treeView, ZenUML, C4); general Markdown formatting (use markdown-best-practices).

references/process-and-time.md

View on GitHub
# Process and Time Diagrams

Sequence, GitGraph, Event Modeling, and User Journey diagrams document what happens *over time* — messages, commits, or steps in order — rather than static structure.

## Sequence Diagram

**When to use:** ordered messages or calls between actors/systems — API calls, protocol exchanges, or any "who calls whom, in what order" interaction.

````markdown
```mermaid
sequenceDiagram
    participant Client
    participant API
    Client->>API: POST /orders
    activate API
    API-->>Client: 201 Created
    deactivate API
```
````

| Arrow | Meaning |
| --- | --- |
| `->>` | Solid line, arrowhead (sync call) |
| `-->>` | Dotted line, arrowhead (response/async) |
| `-)` | Solid, open arrow (fire-and-forget) |
| `-x` | Solid, cross end (message that fails/is dropped) |

`activate`/`deactivate` (or `+`/`-` suffix on the arrow) show a lifeline is busy. `loop ... end`, `alt ... else ... end`, `opt ... end`, and `par ... and ... end` express iteration, branching, optional steps, and parallel actions respectively. `Note over A,B: text` attaches a note spanning participants.

## GitGraph (Git) Diagram

**When to use:** visualizing a branch/commit/merge history — explaining a branching strategy or a specific incident's commit graph.

````markdown
```mermaid
gitGraph
   commit
   branch develop
   checkout develop
   commit
   checkout main
   merge develop
   commit
```
````

Every graph starts on `main`. `branch <name>` creates and switches to a branch; `checkout <name>` switches without creating; `merge <name>` merges that branch into the current one. `commit id: "label" tag: "v1.0"` names/tags a commit; `type: REVERSE` or `type: HIGHLIGHT` changes a commit's rendering.

## Event Modeling Diagram

**When to use:** documenting an event-sourced or CQRS system as a UI/Command/Event timeline — how a user action becomes a command, which produces an event, which updates a read model.

````markdown
```mermaid
eventmodeling

tf 01 ui CartUI
tf 02 cmd AddItem
tf 03 evt ItemAdded
```
````

Each `tf <n> <type> <Name>` line is a Time Frame; `<n>` is a unique reference number (order in the file doesn't matter, only uniqueness). `<type>` is one of `ui`/`pcr` (processor), `cmd`, `rmo` (read model), or `evt` — each type maps to a fixed swimlane (UI/Automation, Command/Read Model, Events). Use the `rf` (reset frame) token to break automatic inference when a flow needs to restart from an external event.

## User Journey Diagram

**When to use:** showing a user's steps across a task and how satisfying each step is — UX/product documentation of an end-to-end flow.

````markdown
```mermaid
journey
    title My working day
    section Go to work
      Make tea: 5: Me
      Go upstairs: 3: Me
    section Go home
      Sit down: 5: Me
```
````

Group steps with `section <name>`. Each task line is `Task name: <score 1-5>: <comma-separated actors>` — the score (1 lowest, 5 highest) drives the plotted satisfaction line.
rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization.Stars: 472kUpdated Claude CodeCodexVerifiedInstall
academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file).Stars: 198kUpdated Claude CodeCodexUnverifiedInstall
doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.Stars: 198kUpdated Claude CodeCodexVerifiedInstall