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

Files

diegosouzapw caa262a4c5 feat(docs): add YAML frontmatter to all docs (title/version/lastUpdated)

Every .md under docs/{architecture,guides,reference,frameworks,routing,
security,compression,ops,diagrams} plus docs/README.md now opens with:

  ---
  title: "<inferred from first H1>"
  version: 3.8.0
  lastUpdated: 2026-05-13
  ---

46 files updated (no docs were skipped — none had pre-existing
frontmatter). [slug]/page.tsx already reads frontmatter.version and
frontmatter.lastUpdated via gray-matter and renders a "v3.8.0" pill
plus a "Last updated" caption, so the UI picks these up automatically.

Helper: scripts/docs/add-frontmatter.mjs — idempotent (skips files that
already start with `---`), falls back to a humanized basename when no
leading H1 exists. Excludes docs/i18n/, docs/screenshots/,
docs/superpowers/, docs/diagrams/exported/. Re-runnable safely.

Also regenerated src/app/docs/lib/docs-auto-generated.ts: 44 docs across
8 sections (Architecture / Guides / Reference / Frameworks / Routing /
Security / Compression / Ops), which now includes the 14 docs that were
missing from the v3.7 sidebar (Cloud Agents, Guardrails, Memory, Skills,
Webhooks, Evals, Authz, Agent Protocols, Repository Map, Provider
Reference, Reasoning Replay, Stealth Guide, Tunnels Guide, Electron
Guide).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

2026-05-13 18:46:05 -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

feat(docs): add YAML frontmatter to all docs (title/version/lastUpdated)

2026-05-13 18:46:05 -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.0	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-37.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.