Skip to content

docs: render flow charts as Mermaid diagrams#41

Open
LeastAction-Labs wants to merge 1 commit into
mainfrom
docs/mermaid-diagrams
Open

docs: render flow charts as Mermaid diagrams#41
LeastAction-Labs wants to merge 1 commit into
mainfrom
docs/mermaid-diagrams

Conversation

@LeastAction-Labs

Copy link
Copy Markdown
Owner

Convert the 11 ASCII flow/state/sequence/architecture diagrams in docs to Mermaid blocks (operator lifecycle, task state machine, OAuth sequence, cron lifecycle, MCP architecture, AI chat security flow, config hierarchies). Directory/hierarchy trees are left as code blocks.

Add Mermaid rendering to the in-app docs renderer:

  • add mermaid dependency
  • new MermaidDiagram component (dynamic-imported, theme-aware via CSS vars, font-ready wait, parse-error fallback)
  • wire code/pre overrides into MarkdownRenderer (covers docs, chatbot, query editor, report explorer)

The shared docs also render on the marketplace site (existing MermaidDiagram) and on GitHub natively.

Convert the 11 ASCII flow/state/sequence/architecture diagrams in docs to
Mermaid blocks (operator lifecycle, task state machine, OAuth sequence, cron
lifecycle, MCP architecture, AI chat security flow, config hierarchies).
Directory/hierarchy trees are left as code blocks.

Add Mermaid rendering to the in-app docs renderer:
- add `mermaid` dependency
- new MermaidDiagram component (dynamic-imported, theme-aware via CSS vars,
  font-ready wait, parse-error fallback)
- wire code/pre overrides into MarkdownRenderer (covers docs, chatbot, query
  editor, report explorer)

The shared docs also render on the marketplace site (existing MermaidDiagram)
and on GitHub natively.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant