Skip to content

fix(docs): drop markers from docs/ — this site renders them into view - #21

Merged
VickyXAI merged 1 commit into
mainfrom
fix/strip-markers-from-rendered-docs
Jul 27, 2026
Merged

fix(docs): drop markers from docs/ — this site renders them into view#21
VickyXAI merged 1 commit into
mainfrom
fix/strip-markers-from-rendered-docs

Conversation

@VickyXAI

Copy link
Copy Markdown
Contributor

#19 put brand markers throughout docs/. That was wrong, and it is live on blockrun.ai right now:

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

Why it shipped

An HTML comment is invisible only where something renders it as HTML.

access to <!-- -->&lt;!-- br:chains.rpc --&gt;<!-- -->40<!-- -->&lt;!-- /br:chains.rpc --&gt;

The same file reads fine in review and broken on the site. That gap is why nobody caught it.

The fix

docs/ goes back to plain numbers — 14 markers stripped across 12 files.

blockrun asserts those numbers in a new brand-numbers.docs.test.ts and fails if a marker ever reappears in the tree. The constraint belongs to the renderer, so the guard lives with the renderer rather than in this repo, which would have to remember a rule about someone else's rendering.

README.md and ECOSYSTEM.md keep their markers — those are only ever rendered by GitHub, where the mechanism works as intended. brand/README.md now documents the split.

Companion

The same class of bug hit public/llms.txt and friends, which are served as text/plain — fixed in the blockrun PR alongside this.

#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.
@VickyXAI
VickyXAI merged commit ebe5c41 into main Jul 27, 2026
1 check passed
@VickyXAI
VickyXAI deleted the fix/strip-markers-from-rendered-docs branch July 27, 2026 05:44
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