mirror of https://github.com/diegosouzapw/OmniRoute.git synced 2026-08-04 14:22:09 +03:00

Files

diegosouzapw 74e290bc70 docs(mcp): regenerate mcp-tools diagram for 43 tools (+ notion); fix count in CLAUDE.md

release/v3.8.8 added notionTools.ts (6 tools) → MCP total is 43, not 37, but the
diagram asset (mcp-tools-43.svg) was never generated and MCP-SERVER.md/CLAUDE.md
still said 37. Create mcp-tools-43.{mmd,svg} (rendered via mermaid-cli), repoint
MCP-SERVER.md + docs/diagrams/README.md, update CLAUDE.md count to 43, and remove
the superseded mcp-tools-37 source/asset.

Note: full 'next build' OOM'd locally (session cgroup limit); the SVG ref resolves
(file present at path) and check:docs-sync passes — CI runs the authoritative build.

2026-06-01 00:15:20 -03:00

exported

docs(mcp): regenerate mcp-tools diagram for 43 tools (+ notion); fix count in CLAUDE.md

2026-06-01 00:15:20 -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-43.mmd

docs(mcp): regenerate mcp-tools diagram for 43 tools (+ notion); fix count in CLAUDE.md

2026-06-01 00:15:20 -03:00

README.md

docs(mcp): regenerate mcp-tools diagram for 43 tools (+ notion); fix count in CLAUDE.md

2026-06-01 00:15:20 -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

title, version, lastUpdated

title	version	lastUpdated
Diagrams	3.8.2	2026-05-13

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/ARCHITECTURE.md, docs/architecture/CODEBASE_DOCUMENTATION.md
auto-combo-9factor.mmd	SVG	docs/routing/AUTO-COMBO.md
resilience-3layers.mmd	SVG	docs/architecture/RESILIENCE_GUIDE.md, CLAUDE.md
i18n-flow.mmd	SVG	docs/guides/I18N.md
mcp-tools-43.mmd	SVG	docs/frameworks/MCP-SERVER.md
cloud-agent-flow.mmd	SVG	docs/frameworks/CLOUD_AGENT.md
authz-pipeline.mmd	SVG	docs/architecture/AUTHZ_GUIDE.md
db-schema-overview.mmd	SVG	docs/architecture/CODEBASE_DOCUMENTATION.md

How to update

Edit *.mmd.
Re-render: npm run docs:render-diagrams (uses @mermaid-js/mermaid-cli).
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

From a doc in docs/<subfolder>/, the relative path becomes ../diagrams/...:

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

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

From the repo root (e.g. CLAUDE.md):

![Resilience layers](./docs/diagrams/exported/resilience-3layers.svg)

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.