mirror of https://github.com/diegosouzapw/OmniRoute.git synced 2026-07-31 20:32:20 +03:00

Files

Diego Rodrigues de Sa e Souza 9b986fa220 docs(architecture): sync stale DB-layer counts (45+/55 → 95+/110+) in REPOSITORY_MAP, db-schema diagram and llm.txt (+42 i18n mirrors) (#6167 )

docs(architecture): sync stale DB-layer counts (45+/55 → 95+/110+) across REPOSITORY_MAP, db-schema diagram, llm.txt + 42 i18n mirrors (#6167). Docs-only; check:docs-all passes locally on the reconstruction. Reds are pre-existing base-red drift on release/v3.8.45 (dast-smoke #6228; executor-kiro.test.ts eslint anys; changelog/package.json version drift) — none introduced by this PR. Integrated into release/v3.8.45.

2026-07-05 04:18:56 -03:00

exported

Release v3.8.40

2026-06-29 08:40:06 -03:00

authz-pipeline.mmd

docs(diagrams): create 8 canonical Mermaid sources + folder structure

2026-05-13 13:53:56 -03:00

auto-combo-12factor.mmd

Release v3.8.40

2026-06-29 08:40:06 -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(architecture): sync stale DB-layer counts (45+/55 → 95+/110+) in REPOSITORY_MAP, db-schema diagram and llm.txt (+42 i18n mirrors) (#6167 )

2026-07-05 04:18: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-94.mmd

Release v3.8.40

2026-06-29 08:40:06 -03:00

README.md

Release v3.8.40

2026-06-29 08:40:06 -03:00

request-pipeline.mmd

Release v3.8.37 (#5053 )

2026-06-26 02:51:06 -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.40	2026-06-28

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-12factor.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-94.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](./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.