Skip to content

docs: rewrite README (accurate counts + current architecture + missing surfaces) - #1493

Merged
Flotapponnier merged 1 commit into
devfrom
docs/readme-rewrite
Jul 26, 2026
Merged

docs: rewrite README (accurate counts + current architecture + missing surfaces)#1493
Flotapponnier merged 1 commit into
devfrom
docs/readme-rewrite

Conversation

@Flotapponnier

Copy link
Copy Markdown
Collaborator

Full README audit + rewrite (previous was 351 lines, 3× stale on core counts). See commit for full delta.

…g surfaces)

Full audit + rewrite based on 3 parallel agent audits. Previous README
was 351 lines and grossly stale:

- Bench count 30 -> 94 (real number today)
- Harness dir count 18 -> 50
- Worker + Prom + Redis 'Railway' -> VPS ocb-par-main (Paris)
- Redis 'Vercel KV / Upstash' -> SRH proxy at kv.openchainbench.com
- Deploy 'manual vercel --prod' -> auto on push to main via CI
- URL /providers -> /products (never mentioned the rename)
- Missing 8 hub routes (/answers, /chains, /compare, /hyperliquid,
  /perps, /prediction-markets, /rpc, /alternatives)
- Missing surfaces: /feed.json (new), /llms-full.txt, /rss.xml,
  /api/cite/[slug]/[format], structured-data richness
  (Dataset + StatisticalReport + Observation + FAQPage + microdata),
  CDN blob fastpath, LKG fallback, middleware behaviors
- Missing at-a-glance numbers + badges + repo layout section
- Removed dead SEO TODOs list and hand-numbered bench IDs in tree

Down to 148 lines. Tighter pitch, complete endpoint table, current
architecture diagram, links to CONTRIBUTING.md + docs/architecture.md
for long-form.
@Flotapponnier
Flotapponnier merged commit 8e41004 into dev Jul 26, 2026
1 check failed
Flotapponnier added a commit that referenced this pull request Jul 26, 2026
…g surfaces) (#1493) (#1494)

Full audit + rewrite based on 3 parallel agent audits. Previous README
was 351 lines and grossly stale:

- Bench count 30 -> 94 (real number today)
- Harness dir count 18 -> 50
- Worker + Prom + Redis 'Railway' -> VPS ocb-par-main (Paris)
- Redis 'Vercel KV / Upstash' -> SRH proxy at kv.openchainbench.com
- Deploy 'manual vercel --prod' -> auto on push to main via CI
- URL /providers -> /products (never mentioned the rename)
- Missing 8 hub routes (/answers, /chains, /compare, /hyperliquid,
  /perps, /prediction-markets, /rpc, /alternatives)
- Missing surfaces: /feed.json (new), /llms-full.txt, /rss.xml,
  /api/cite/[slug]/[format], structured-data richness
  (Dataset + StatisticalReport + Observation + FAQPage + microdata),
  CDN blob fastpath, LKG fallback, middleware behaviors
- Missing at-a-glance numbers + badges + repo layout section
- Removed dead SEO TODOs list and hand-numbered bench IDs in tree

Down to 148 lines. Tighter pitch, complete endpoint table, current
architecture diagram, links to CONTRIBUTING.md + docs/architecture.md
for long-form.

Co-authored-by: Florent Tapponnier <contact@mobula.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant