docs-mermaid

Generate Mermaid diagrams for nexus-agents documentation from user requests.

18|1|Updated Jan 3, 2026
One-click install
npx skills add https://github.com/nexus-substrate/nexus-agents --skill docs-mermaid-nexus-substrate
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-mermaid
Source: https://github.com/nexus-substrate/nexus-agents/tree/main/skills/docs-mermaid
Command: npx skills add https://github.com/nexus-substrate/nexus-agents --skill docs-mermaid-nexus-substrate

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

It helps you convert complex system behavior into precise, renderable Mermaid diagrams that are easy to share, audit, and maintain in nexus-agents documentation.

Core Features & Use Cases

  • Accurate diagram-type selection: Chooses the right Mermaid syntax (flowchart, sequence, stateDiagram-v2, classDiagram, erDiagram, gantt, gitGraph) based on what the user is actually asking.
  • Documentation-ready output: Produces diagrams as GitHub-renderable Mermaid fenced blocks in the correct lowercase format.
  • Smart redirection to specialized lanes: Redirects quantitative visuals to docs-chart and illustrative/hero visuals to docs-image, reducing diagram sprawl and misuse.

Quick Start

Generate a sequence diagram showing how a vote routes through the consensus engine and the voter panel.

Frequently Asked Questions about docs-mermaid

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate Mermaid sequence diagrams for documentation?

You can generate Mermaid sequence diagrams by describing the component interactions or lifecycles you need to visualize. The tool translates your request into the correct Mermaid syntax and outputs GitHub-renderable fenced blocks for direct documentation use.

What is the best way to diagram a proposal lifecycle and voting flow?

To diagram a proposal lifecycle and voting flow, you describe the decision branches and data relationships. The tool selects the appropriate diagram type, such as a state machine or flowchart, and generates precise Mermaid syntax to render the system behavior clearly.

When do I need a state machine diagram versus a flowchart for system behavior?

You need a state machine diagram to show lifecycle states and transitions, whereas a flowchart maps decision branches and process flows. The tool evaluates your request and automatically applies the correct Mermaid diagram type structure for your specific use case.

Can I use Mermaid to create quantitative charts for my documentation?

Mermaid is not intended for quantitative charts within this tool. Quantitative visual requests are redirected to specialized charting skills, ensuring diagrams remain focused on architecture, interactions, and structural relationships rather than numerical data.

Does Mermaid support class diagrams and entity relationship diagrams for schema relationships?

Yes, Mermaid supports class diagrams and entity relationship diagrams. The tool generates correct classDiagram and erDiagram syntax to map data schema relationships, adapter types, and engine structures into renderable, documentation-ready visual formats.

What are the limitations of using Mermaid for illustrative hero visuals?

Mermaid is limited to structural and logical diagrams, meaning it cannot produce illustrative or hero visuals. Requests for illustrative images are redirected to specialized image generation skills to prevent diagram misuse and sprawl.