mirror of https://github.com/diegosouzapw/OmniRoute.git synced 2026-08-17 20:52:15 +03:00

Files

Diego Rodrigues de Sa e Souza ed4944e771 docs(readme): animated SVG for the 4-tier auto-fallback cascade (#7615 )

* docs(readme): replace tier-cascade ASCII diagram with animated SMIL SVG

The 4-tier auto-fallback block in the README becomes a self-contained
animated SVG (docs/diagrams/tier-cascade.svg, 16 KB): a 16s loop in 4
acts where requests flow from the IDE through the smart router into the
active tier, and each quota-out/budget-hit transition hands the traffic
down to the next tier, ending on the always-on free tier. SMIL only — no
JS, no external fonts — so it animates inside GitHub's camo/<img>
sandbox. Content is verbatim from the previous ASCII art; the full flow
is preserved in the img alt text. docs/diagrams/README.md gains a
hand-authored-diagrams section documenting it.

* docs(changelog): add fragment for #7615 (animated tier-cascade SVG)

* docs(readme): align tier-cascade SVG palette with DESIGN_SYSTEM.md

Retrofit to the canonical tokens (docs/architecture/DESIGN_SYSTEM.md §3.1):
dark bg #0b0e14 + the 32px graph-paper grid wallpaper (the product/site
signature), surface #161b22, borders rgba(255,255,255,.08), radius 14,
text-muted #a1a1aa. Brand semantics fixed: the router hub glyph + glow now
use primary #e54d5e (matching the favicon hub mark) and the title carries
the --grad-brand gradient (primary → accent-3); exhaustion states
(quota out / budget hit flashes, spent-tier status dots, hand-off dots)
move from brand coral to the semantic error token #ef4444; topology paths
use accent #6366f1 with accent-2 #8b5cf6 request dots; success stays
#22c55e. Re-validated (0 warnings) and re-verified frame-by-frame.

2026-07-17 12:14:47 -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

docs(readme): animated SVG for the 4-tier auto-fallback cascade (#7615 )

2026-07-17 12:14:47 -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

tier-cascade.svg

docs(readme): animated SVG for the 4-tier auto-fallback cascade (#7615 )

2026-07-17 12:14:47 -03:00

README.md

title, version, lastUpdated

title	version	lastUpdated
Diagrams	3.8.49	2026-07-17

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

Hand-authored animated diagrams

Not every diagram comes from a .mmd source. Hand-authored SVGs live at this directory's root and animate with SMIL only (no JS, no external fonts), so they play inside GitHub's <img> sandbox:

File	Used in	Notes
tier-cascade.svg	README.md (root)	Animated 4-tier auto-fallback cascade (16s loop, 4 acts). Edit the SVG directly — there is no `.mmd` source.

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.