Commit Graph

3 Commits

Author SHA1 Message Date
Diego Rodrigues de Sa e Souza
d2c35e8d58 docs(readme): re-audit numbers, fix table scroll, refresh contributors (#8243)
Numbers sweep (text + SVGs now consistent):
- Routing strategies 18 -> 19 (add cache-optimized row; hero/tier-cascade/
  strategies-grid alts + comparison table)
- Coding agents 26 -> 33 in promise-pillars alt
- "10 engines above" -> 12 (codex-responses)
- Re-render the 5 hand-authored SVGs to match the vetted text: readme-hero
  (268->278, ~1.4B->~1.53B, 18->19), free-tier-budget (~1.4B->~1.53B,
  ~2.0B->~2.15B, 39->43 pools), promise-pillars + cli-terminal (268->278),
  compression-pipeline (11->12 engine cells, re-laid out)

Contributors:
- Headline 350+ -> 500+ (507 real human identities)
- Card commit counts via GitHub contributions API: oyi77 213, JxnLexn 58,
  backryun 53, herjarsa 25; reorder backryun above chirag127 (53 > 46)

Table horizontal-scroll fixes:
- Screenshots: markdown images -> HTML table with width=400 (was unbounded)
- "Every major lab" icons width 98 -> 80; "Free Forever" cards 127 -> 104
- MCP/A2A endpoints: full URLs -> paths (host stated once above)
- Trim over-long Headroom cell; comparison "Routing strategies" cell
- Video thumbs 280 -> 264

Verbosity/naturalness:
- Dedup strategies-grid alt (was relisting the table above)
- Trim Quota-Share What's-New bullet; fix negative-parallelism in CLI intro

check:docs-counts STRICT green; docs-sync PASS; all SVGs well-formed.

Co-authored-by: Probe Test <probe@example.com>
2026-07-23 01:33:22 -03:00
Diego Rodrigues de Sa e Souza
5d1ad576a1 feat(quality): gate the free-tier headline so it can never silently drift again (#7798)
* docs(free-tiers): correct the headline to the 1.37B the catalog actually computes

The 2026-06-17 honesty correction landed 1.54B, but v3.8.42 reclassified longcat
from a 150M/mo recurring grant to a one-time 10M signup credit and the doc was
never resynced. Verified against computeFreeModelTotals() at every release tag
from 3.8.13 to HEAD: no free provider was lost by mistake.

* feat(quality): gate the free-tier headline against the live catalog

The README headlined ~1.6B free tokens/mo for seven releases after the catalog had
already been corrected down to 1.37B. No gate watched that number, so the drift was
invisible — check:docs-counts only covered providers, locales, executors, strategies,
oauth, a2a skills and cloud agents.

Adds a STRICT check that runs computeFreeModelTotals() (the same function behind
/api/free-tier/summary) and fails the build when README.md or FREE_TIERS.md publish a
headline that no longer rounds to it. Degrades to a skip if tsx is unavailable rather
than going falsely red.

The extractor is a whitelist: the theoretical ceiling (~10B), the historical ~1.94B and
per-model rows (~1.00B) are legitimate figures that must never trip the gate.

Also adds the biweekly-audit note under the README headline, so readers know the number
moves both ways and is what the catalog computes rather than a rounded-up best case.

* feat(quality): extend the counts gate to engines, MCP tools/scopes and CLI tools

The v3.8.49 audit found four more numbers that had silently drifted, all invisible to
CI because check:docs-counts only watched providers/locales/executors/strategies/oauth/
a2a/cloud-agents: 10->11 compression engines, 94->104 MCP tools, 30->31 scopes,
26->33 CLI tools.

Adds a generic makeNumberClaimValidator that reads every fact in ONE tsx subprocess via
the same functions the app serves (ENGINE_IDS, countUniqueMcpTools, the live scope union,
CLI_TOOLS) — never a hardcoded copy — with DATA_DIR redirected to a throwaway dir so
importing the MCP tool modules can't touch the operator's SQLite. Each check declares a
skip pattern so legitimate non-aggregate figures never trip it: per-module tool counts
('Memory tool definitions (3 tools)') and the CLI catalog total sitting next to the MCP
total. Degrades to a skip when tsx is unavailable rather than a false red.

7 new unit tests (all pass) covering the exact stale values this audit found and proving
per-module counts are ignored.

* docs(diagrams): sync the animated cards and mermaid sources to the audited v3.8.49 numbers

The README text was fixed in #7795 but the SVG cards and mermaid sources kept the
old numbers baked in — exactly the drift the readers see first.

- compression-pipeline.svg: 10 -> 11 engine cells (Omniglyph added as #8, matching
  the README alt text), re-spaced 51px cells, highlight cascade re-timed, the
  Caveman kill-dot repositioned inside its cell, default-stack bracket recentered
- free-tier-budget.svg: bar and grid rebuilt from computeFreeModelTotals() — 21 -> 19
  countable pools (LongCat-2.0 moved to one-time credit, Inclusion provider removed),
  huggingchat entry is now ERNIE 4.5 VL, kiro shows Claude Sonnet 4.5, signup credits
  ~616M -> ~626M (+longcat 10M pill), aria said 'about 1.6 billion' -> 1.4/2.0,
  lower sections shifted up 30px (viewBox 872 -> 842)
- promise-pillars.svg: 26 -> 33 coding agents
- mcp-tools-94.mmd -> mcp-tools-104.mmd: real per-collection unique contributions
  (42 base + memory 3 + skill 4 + githubSkill 3 + pool 6 + gamification 8 + plugin 8
  + notion 6 + obsidian 22 + compression 2), exported SVG regenerated, zh-CN ref synced
- request-pipeline.mmd: 17 -> 18 strategies, exported SVG regenerated
- README free-tier alt + docs/diagrams/README.md synced to the same numbers

Both edited cards pass validate-svg.sh and were render-verified at 4 timestamps
(animation runs; first frame is the finished composition).

* docs(env): register the 4 env vars missing from the .env.example contract (base-red unblock)

FREE_PROXY_AUTO_SYNC_ENABLED / FREE_PROXY_AUTO_SYNC_INTERVAL_MS (scheduler.ts) and
MITM_ROOT_CA_ENABLED / MITM_CERT_MODE (mitm manager/server, #6684) landed on
release/v3.8.49 without their .env.example + ENVIRONMENT.md entries, turning the
docs-gates job red for every PR on the branch. Documented with their real defaults
and the set-by-manager caveat for MITM_CERT_MODE.

* fix(dashboard): narrow the Codex session ParseResult with an equality check (base-red unblock)

#7725 landed 'if (!result.ok)' in OAuthModal — under this repo's strict:false,
tsc 6 only narrows a discriminated union on the equality form, so the negation
raised TS2339 (Property 'error' does not exist on ParseResult) and turned the
dashboard-typecheck gate red for every PR on release/v3.8.49. Runtime semantics
are identical (ok is a strict boolean).

Also ratchets the frozen baseline down 260 -> 259: the real fix here plus 3
baselined errors that other merges already fixed (CostOverviewTab TS2304,
SidebarTab TS2322, FreePoolTab TS2304). Baseline diff is deletions-only.

* fix(dashboard): keep OAuthModal within the frozen file-size cap

The narrowing comment pushed the file to 1032 > 1030 frozen; the rationale lives
in the previous commit message and the dashboard-typecheck gate itself guards the
'=== false' form from being refactored back to '!result.ok'.

* test(providers): align the grok-web credential assertion with the #7567 hint (base-red unblock)

#7713 added hintKey/hintFallback (proactive cf_clearance/User-Agent guidance) to the
grok-web web-session metadata without touching this test's deepEqual, turning unit
shard 2/4 red for every PR on release/v3.8.49. Rewritten in the same contract-only
style the file already uses for lmarena: structural fields stay strictly asserted,
the hint asserts key + intent (cf_clearance / User-Agent) without freezing operator
copy. Net stronger than before — the old assertion never checked the hint at all.

* test(golden): regenerate translate-path snapshot for the notion-web endpoint move (base-red unblock)

#7768 switched notion-web to app.notion.com without regenerating the golden,
turning unit shard 3/4 red for every PR on release/v3.8.49. Two-line regen,
reflects the deliberate production change.
2026-07-19 19:07:44 -03:00
Diego Rodrigues de Sa e Souza
ea5862d15b docs(readme): animate CLI command list + compression flow as SMIL SVGs (#7637)
* docs(readme): animate CLI command list + compression flow as SMIL SVGs

Two more README ASCII/text blocks become hand-authored animated SVGs
(SMIL only, GitHub <img>-sandbox safe, DESIGN_SYSTEM.md palette),
following the tier-cascade / pool / combo pattern:

- cli-terminal.svg — compact terminal window (640x500) cycling three
  real CLI screens (providers list / combo list / health) with
  character-by-character typing, output formats copied from the actual
  bin/cli printers (headings, column layout, status colors, circuit
  breaker block), plus a scrolling ticker carrying the full 30-subcommand
  list the image replaces (also preserved in the img alt).
- compression-pipeline.svg — the 'Client -> 10 engines -> Provider'
  flow line as an animated funnel: 10,000 tok in, ~1,080 tok out, token
  dots evaporating engine by engine behind the cells, RTK -> Caveman
  default stack highlighted, a code token passing through untouched
  (always preserved byte-perfect) and the stacked savings math badge.

Registered both in docs/diagrams/README.md (hand-authored table).

* docs(changelog): add fragment for #7637 (CLI terminal + compression SVGs)

* docs(readme): enlarge CLI terminal diagram (full-width, 1200x700)

Per review: the mini 640x500 terminal read too small. Rebuild it as a
full-width widescreen terminal (viewBox 1200x700, embedded at width=100%)
with larger type, wider aligned columns, 6 provider rows and 4 combo rows
so each screen fills the frame. Same 3 real CLI screens, same SMIL, same
DESIGN_SYSTEM.md palette, same command-ticker footer.
2026-07-17 16:58:59 -03:00