From ed4944e771d3e5dba944534414cf470c85598f22 Mon Sep 17 00:00:00 2001 From: Diego Rodrigues de Sa e Souza <8016841+diegosouzapw@users.noreply.github.com> Date: Fri, 17 Jul 2026 12:14:47 -0300 Subject: [PATCH] docs(readme): animated SVG for the 4-tier auto-fallback cascade (#7615) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * 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/ 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. --- README.md | 19 +- .../7615-readme-tier-cascade-svg.md | 1 + docs/diagrams/README.md | 14 +- docs/diagrams/tier-cascade.svg | 269 ++++++++++++++++++ 4 files changed, 283 insertions(+), 20 deletions(-) create mode 100644 changelog.d/maintenance/7615-readme-tier-cascade-svg.md create mode 100644 docs/diagrams/tier-cascade.svg diff --git a/README.md b/README.md index 45c9374fb1..2e6a70aa1e 100644 --- a/README.md +++ b/README.md @@ -186,24 +186,7 @@
-``` -┌──────────────────────────────────────────────────────────┐ -│ Your IDE / CLI (Claude Code, Cursor, Cline…) │ -└─────────────────────────┬──────────────────────────────────┘ - │ http://localhost:20128/v1 - ▼ -┌──────────────────────────────────────────────────────────┐ -│ OmniRoute — Smart Router │ -│ RTK + Caveman compression · 18 routing strategies │ -│ Circuit breakers · TLS stealth · MCP · A2A · Guardrails │ -└─────────────────────────┬──────────────────────────────────┘ - ┌─────────────┬────┴────────┬─────────────┐ - ▼ Tier 1 ▼ Tier 2 ▼ Tier 3 ▼ Tier 4 - SUBSCRIPTION API KEY CHEAP FREE - Claude Code, DeepSeek, GLM $0.5, Kiro, Qoder, - Codex, Copilot Groq, xAI MiniMax $0.2 Pollinations - quota out? ───▶ budget hit? ─▶ budget hit? ─▶ always on -``` +OmniRoute request flow: your IDE or CLI (Claude Code, Cursor, Cline…) calls one local endpoint (http://localhost:20128/v1); the OmniRoute Smart Router (RTK + Caveman compression, 18 routing strategies, circuit breakers, TLS stealth, MCP, A2A, guardrails) auto-falls back across 4 provider tiers — Tier 1 Subscription (Claude Code, Codex, Copilot), quota out? Tier 2 API Key (DeepSeek, Groq, xAI), budget hit? Tier 3 Cheap (GLM $0.5, MiniMax $0.2), budget hit? Tier 4 Free (Kiro, Qoder, Pollinations) — always on.
diff --git a/changelog.d/maintenance/7615-readme-tier-cascade-svg.md b/changelog.d/maintenance/7615-readme-tier-cascade-svg.md new file mode 100644 index 0000000000..593427f876 --- /dev/null +++ b/changelog.d/maintenance/7615-readme-tier-cascade-svg.md @@ -0,0 +1 @@ +- **README tier-cascade diagram animated** (`docs/diagrams/tier-cascade.svg`): the ASCII 4-tier auto-fallback block in the README is now a self-contained animated SVG (SMIL-only, 16 KB, 16s loop in 4 acts — quota-out/budget-hit hand-offs down to the always-on free tier) that plays inside GitHub's `` sandbox; full flow preserved in the img alt text, hand-authored-diagrams section added to `docs/diagrams/README.md` (#7615). diff --git a/docs/diagrams/README.md b/docs/diagrams/README.md index c13a411222..2de1805fe3 100644 --- a/docs/diagrams/README.md +++ b/docs/diagrams/README.md @@ -1,7 +1,7 @@ --- title: "Diagrams" -version: 3.8.40 -lastUpdated: 2026-06-28 +version: 3.8.49 +lastUpdated: 2026-07-17 --- # Diagrams @@ -21,6 +21,16 @@ Mermaid sources (`.mmd`) and exported SVGs for OmniRoute v3.8.0 architecture flo | [authz-pipeline.mmd](./authz-pipeline.mmd) | [SVG](./exported/authz-pipeline.svg) | docs/architecture/AUTHZ_GUIDE.md | | [db-schema-overview.mmd](./db-schema-overview.mmd) | [SVG](./exported/db-schema-overview.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 `` sandbox: + +| File | Used in | Notes | +| ---------------------------------------- | ---------------- | ---------------------------------------------------------------------------- | +| [tier-cascade.svg](./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 1. Edit `*.mmd`. diff --git a/docs/diagrams/tier-cascade.svg b/docs/diagrams/tier-cascade.svg new file mode 100644 index 0000000000..4f819814fd --- /dev/null +++ b/docs/diagrams/tier-cascade.svg @@ -0,0 +1,269 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Your IDE / CLI + Claude Code · Cursor · Cline · every AI tool + + + + + + + http://localhost:20128/v1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + OmniRoute — Smart Router + RTK + Caveman compression · 18 routing strategies + Circuit breakers · TLS stealth · MCP · A2A · Guardrails + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + TIER 1 · SUBSCRIPTION + + + + + + + Claude Code + Codex + Copilot + + + + + + + + + + TIER 2 · API KEY + + + + + + + DeepSeek + Groq + xAI + + + + + + + + + + TIER 3 · CHEAP + + + + + + + GLM $0.5 + MiniMax $0.2 + + + + + + + + + + TIER 4 · FREE + + + + + + Kiro + Qoder + Pollinations + + + + + + + + + + + + + quota out? + + + + budget hit? + + + + budget hit? + + + + + + + + + + + + + + + + + + + + + + + + ALWAYS ON + + + + AUTO-FALLBACK CASCADE · NEVER STOP CODING +