Skip to content

docs: bind the docs tree too, and add the tool the table forgot - #19

Merged
VickyXAI merged 1 commit into
mainfrom
feat/brand-numbers-docs
Jul 26, 2026
Merged

docs: bind the docs tree too, and add the tool the table forgot#19
VickyXAI merged 1 commit into
mainfrom
feat/brand-numbers-docs

Conversation

@VickyXAI

Copy link
Copy Markdown
Contributor

Follow-up to #18, which covered README, ECOSYSTEM and three pages.

Why the rest of docs/ matters more than it looks

blockrun/docs is a symlink into this repo, so blockrun.ai serves these files directly. The 11 stale numbers here were live on the marketing site:

Claim Was Now Files
RPC chains 40+ 40 6
MCP tools 18 19 3
Savings up to 78% 87% / 98%, baseline named 2

The README table was missing a tool

It listed 18 rows — which is exactly why "18 tools" looked correct. blockrun_polymarket was absent. A count that agrees with a wrong list is still wrong.

Row added from blockrun-mcp/src/tools/polymarket.ts; the table is now 19 rows and the count is a marker. The same omission existed on the website and is fixed there in the companion PR.

Two places take a reworded claim instead of a marker

An HTML comment is inert in markdown body text, but not everywhere:

  • YAML frontmatterdescription: becomes a meta tag verbatim, so a comment would ship into <meta>
  • a page heading — the text becomes the anchor slug, so a comment would leak into the id

Both were reworded to drop the literal, with the precise marked number kept in the body immediately below.

Sync script

Picks up the symlink fix. Without it, running the script from blockrun would follow docs/ back into this submodule and rewrite these files from the wrong repo's snapshot — found by pointing the script at blockrun for the first time.

#18 covered README, ECOSYSTEM and three pages. The rest of docs/ was still
hand-maintained, which matters more than it looks: blockrun's docs/ is a symlink
into this repo, so blockrun.ai serves these files directly. 11 stale numbers
were live on the site — "40+ chains" for a list of exactly 40, "18 tools" for
19, "up to 78%" against no stated baseline.

The README tool table listed 18 rows. blockrun_polymarket was missing, which is
why 18 looked right: the count agreed with a list that was itself wrong. Row
added from blockrun-mcp/src/tools/polymarket.ts; the table is now 19 and the
count is a marker.

Two places take a reworded claim instead of a marker, because an HTML comment
would be visible there rather than inert:

  YAML frontmatter  the description becomes a meta tag verbatim
  a page heading    the text becomes the anchor slug

Both keep the precise, marked number in the body directly below.

Picks up the sync script's symlink fix. Without it, running the script from
blockrun would follow docs/ back into this submodule and rewrite these files
from the wrong repo's snapshot.
@VickyXAI
VickyXAI merged commit 14987ad into main Jul 26, 2026
1 check passed
@VickyXAI
VickyXAI deleted the feat/brand-numbers-docs branch July 26, 2026 05:57
VickyXAI added a commit that referenced this pull request Jul 27, 2026
…#21)

#19 put brand markers throughout docs/. That was wrong, and it shipped: docs/ is
symlinked into the blockrun repo and served through its docs renderer, which
escapes the HTML comment instead of dropping it. Live on blockrun.ai right now:

  JSON-RPC 2.0 access to <!-- br:chains.rpc -->40<!-- /br:chains.rpc --> blockchains

An HTML comment is invisible only where something renders it as HTML. GitHub
does; that renderer does not. The same file therefore read fine in review and
broken on the site, which is exactly why nobody caught it in #19.

docs/ goes back to plain numbers. blockrun asserts them in
brand-numbers.docs.test.ts and fails if a marker ever reappears there — the
constraint belongs to the renderer, so the guard lives with the renderer rather
than in the repo that would have to remember it.

README.md and ECOSYSTEM.md keep their markers. Those are only ever rendered by
GitHub, where the mechanism works as intended.

Co-authored-by: 1bcMax <viewitter@gmail.com>
VickyXAI added a commit that referenced this pull request Jul 27, 2026
#18, #19 and #21 each swept this tree by hand for whichever phrasings came to
mind, and each found a different subset. What none of them found:

  64 models / 64 LLMs   29 places — the catalog serves 66
  84 AI models           9 places — 86 across every modality
  a free tier of 10      4 places — 8 are published; the rest are withheld
  Save 78% / up to 94%   7 places — two more savings figures, five in total

The claim SHAPES varied, not the numbers, which is exactly what someone
scanning for "64" will not notice.

Found by sweeping for the shape — a number in front of the claim vocabulary —
instead of for remembered phrasings. blockrun now runs that sweep as a test
over this tree on every PR, so the next one fails there rather than shipping.
Numbers that only look like claims are exempted by name with a reason, so the
allowlist cannot quietly grow into a no-op.

README's last unmarked savings claim gets a marker. The docs tree cannot take
them: blockrun renders it and escapes the comment into view.

docs/sdks/xrpl.md is deliberately untouched. It documents the XRPL gateway,
decommissioned 2026-06-06 — restating its numbers would be polishing a page
that should probably not be published at all. Flagged, not fixed.

Co-authored-by: 1bcMax <viewitter@gmail.com>
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