pjandro/OmniRoute
1
0
Fork 0
mirror of https://github.com/diegosouzapw/OmniRoute.git synced 2026-08-19 21:52:21 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
ee97583e02c03cc21f7df8ec2451e7034f76eebd
OmniRoute/docs/diagrams
History
diegosouzapw 519fdf41b8 chore(docs): add npm run docs:render-diagrams and export SVGs 
Add scripts/docs/render-diagrams.mjs as a thin wrapper around
@mermaid-js/mermaid-cli (mmdc):

- Renders every docs/diagrams/*.mmd into docs/diagrams/exported/*.svg
- Writes a Puppeteer config with --no-sandbox for Ubuntu 23.10+/WSL
- Exits non-zero on first failure so CI can gate on rendering

Expose it as `npm run docs:render-diagrams` and commit the initial
8 rendered SVGs so reviewers see the diagrams without having to install
the renderer locally.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-13 13:54:09 -03:00
..
exported
chore(docs): add npm run docs:render-diagrams and export SVGs
2026-05-13 13:54:09 -03:00
authz-pipeline.mmd
docs(diagrams): create 8 canonical Mermaid sources + folder structure
2026-05-13 13:53:56 -03:00
auto-combo-9factor.mmd
docs(diagrams): create 8 canonical Mermaid sources + folder structure
2026-05-13 13:53:56 -03:00
cloud-agent-flow.mmd
docs(diagrams): create 8 canonical Mermaid sources + folder structure
2026-05-13 13:53:56 -03:00
db-schema-overview.mmd
docs(diagrams): create 8 canonical Mermaid sources + folder structure
2026-05-13 13:53:56 -03:00
i18n-flow.mmd
docs(diagrams): create 8 canonical Mermaid sources + folder structure
2026-05-13 13:53:56 -03:00
mcp-tools-37.mmd
docs(diagrams): create 8 canonical Mermaid sources + folder structure
2026-05-13 13:53:56 -03:00
README.md
docs(diagrams): create 8 canonical Mermaid sources + folder structure
2026-05-13 13:53:56 -03:00
request-pipeline.mmd
docs(diagrams): create 8 canonical Mermaid sources + folder structure
2026-05-13 13:53:56 -03:00
resilience-3layers.mmd
docs(diagrams): create 8 canonical Mermaid sources + folder structure
2026-05-13 13:53:56 -03:00

README.md

Diagrams

Mermaid sources (.mmd) and exported SVGs for OmniRoute v3.8.0 architecture flows.

Canonical diagrams

Source Exported Used in
request-pipeline.mmd SVG docs/ARCHITECTURE.md, docs/CODEBASE_DOCUMENTATION.md
auto-combo-9factor.mmd SVG docs/AUTO-COMBO.md
resilience-3layers.mmd SVG docs/RESILIENCE_GUIDE.md, CLAUDE.md
i18n-flow.mmd SVG docs/I18N.md
mcp-tools-37.mmd SVG docs/MCP-SERVER.md
cloud-agent-flow.mmd SVG docs/CLOUD_AGENT.md
authz-pipeline.mmd SVG docs/AUTHZ_GUIDE.md
db-schema-overview.mmd SVG docs/CODEBASE_DOCUMENTATION.md

How to update

  1. Edit *.mmd.
  2. Re-render: npm run docs:render-diagrams (uses @mermaid-js/mermaid-cli).
  3. Commit both .mmd and .svg.

If @mermaid-js/mermaid-cli is not available locally, install it once:

npm install -g @mermaid-js/mermaid-cli

The script renders every .mmd in docs/diagrams/ into docs/diagrams/exported/*.svg with a white background, suitable for both dark and light themes.

Linking from a doc

![Request pipeline](./diagrams/exported/request-pipeline.svg)

> Source: [diagrams/request-pipeline.mmd](./diagrams/request-pipeline.mmd)

Conventions

  • One concept per diagram. Don't try to fit the whole platform in one chart.
  • Keep node labels short (3–6 words). Use <br/> for line breaks inside nodes.
  • Prefer flowchart LR for pipelines and flowchart TB for layered models.
  • Use sequenceDiagram for interactive (request/response) flows.
  • Use erDiagram for database schema overviews.
  • Update both .mmd and .svg in the same commit. Keep them in lock-step.
Reference in New Issue View Git Blame Copy Permalink