From eedb4bc0344b85cf69e3abd92d6ddc5a4be21d5f Mon Sep 17 00:00:00 2001 From: 1bcMax Date: Sun, 26 Jul 2026 22:43:13 -0700 Subject: [PATCH] =?UTF-8?q?fix(docs):=20drop=20markers=20from=20docs/=20?= =?UTF-8?q?=E2=80=94=20this=20site=20renders=20them=20into=20view?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit #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 40 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. --- brand/README.md | 17 +++++++++++++++++ docs/api-reference/chat-completions.md | 2 +- docs/api-reference/multi-chain-rpc.md | 4 ++-- docs/api-reference/prediction-markets.md | 2 +- docs/getting-started/quickstart.md | 2 +- docs/mcp/blockrun-mcp.md | 2 +- docs/mcp/skills.md | 2 +- docs/products/franklin.md | 2 +- docs/products/intelligence/overview.md | 2 +- docs/products/routing/clawrouter.md | 2 +- docs/resources/ecosystem.md | 2 +- docs/resources/faq.md | 2 +- docs/x402/endpoints.md | 2 +- 13 files changed, 30 insertions(+), 13 deletions(-) diff --git a/brand/README.md b/brand/README.md index 1e6a8c6..b134fe3 100644 --- a/brand/README.md +++ b/brand/README.md @@ -33,3 +33,20 @@ node scripts/sync-brand-numbers.mjs # rewrite markers from the snapsho node scripts/sync-brand-numbers.mjs --check # exit 1 on drift, never fetches (CI) node scripts/sync-brand-numbers.mjs --refresh # pull a newer artifact, then rewrite ``` + +### `docs/` must NOT carry markers + +An HTML comment is invisible only where something renders it as HTML. GitHub +does. **blockrun.ai does not** — `docs/` is symlinked into the blockrun repo and +served through its docs renderer, which escapes the comment and prints it: + +``` +JSON-RPC 2.0 access to 40 blockchains +``` + +The same file therefore reads fine on GitHub and broken on the site. `docs/` +keeps plain numbers; blockrun asserts them in `brand-numbers.docs.test.ts` and +fails if a marker ever reappears there. + +Markers are fine in `README.md` and `ECOSYSTEM.md` — those are only ever +rendered by GitHub. diff --git a/docs/api-reference/chat-completions.md b/docs/api-reference/chat-completions.md index 3887140..e4cefa7 100644 --- a/docs/api-reference/chat-completions.md +++ b/docs/api-reference/chat-completions.md @@ -222,7 +222,7 @@ console.log(result.choices[0].message.content); ::::cards :::card{title="Browse all models" href="models.md" icon="Brain"} -66 chat models with live pricing — pick the right model and ID for your call. +66 chat models with live pricing — pick the right model and ID for your call. ::: :::card{title="Error handling" href="errors.md" icon="Code"} diff --git a/docs/api-reference/multi-chain-rpc.md b/docs/api-reference/multi-chain-rpc.md index b5b8a88..b40ac5d 100644 --- a/docs/api-reference/multi-chain-rpc.md +++ b/docs/api-reference/multi-chain-rpc.md @@ -5,13 +5,13 @@ description: Standard JSON-RPC 2.0 access to every supported blockchain through # Multi-chain RPC — one endpoint, every chain -Standard JSON-RPC 2.0 access to 40 blockchains through a single endpoint. No account, no API key, no monthly plan — pay **$0.004 per call** in USDC over x402. Built for AI agents that read on-chain data across many chains from one wallet. +Standard JSON-RPC 2.0 access to 40 blockchains through a single endpoint. No account, no API key, no monthly plan — pay **$0.004 per call** in USDC over x402. Built for AI agents that read on-chain data across many chains from one wallet. BlockRun proxies upstream RPC gateways with x402 settlement, so an agent can query any supported chain without onboarding to a node provider. ## The problem it solves -Traditional RPC providers (Alchemy, Infura, QuickNode) make you sign up, manage an API key, and pick a monthly plan with rate-limit tiers — **per chain**. An agent that needs Ethereum *and* Base *and* Solana *and* Polygon ends up with four accounts and four keys. BlockRun gives you one endpoint for 40 chains, paid per call, with on-chain settlement receipts. +Traditional RPC providers (Alchemy, Infura, QuickNode) make you sign up, manage an API key, and pick a monthly plan with rate-limit tiers — **per chain**. An agent that needs Ethereum *and* Base *and* Solana *and* Polygon ends up with four accounts and four keys. BlockRun gives you one endpoint for 40 chains, paid per call, with on-chain settlement receipts. ## Endpoint diff --git a/docs/api-reference/prediction-markets.md b/docs/api-reference/prediction-markets.md index c38249c..30145ce 100644 --- a/docs/api-reference/prediction-markets.md +++ b/docs/api-reference/prediction-markets.md @@ -395,7 +395,7 @@ Feed market and wallet data into an LLM to analyze odds and positioning. ::: :::card{title="Multi-chain RPC" href="multi-chain-rpc.md" icon="Route"} -Read on-chain data across 40 chains to complement wallet identity lookups. +Read on-chain data across 40 chains to complement wallet identity lookups. ::: :::card{title="Error handling" href="errors.md" icon="Code"} diff --git a/docs/getting-started/quickstart.md b/docs/getting-started/quickstart.md index 0ee0f5e..441ee75 100644 --- a/docs/getting-started/quickstart.md +++ b/docs/getting-started/quickstart.md @@ -16,7 +16,7 @@ A terminal, and ~$5 of USDC on **Base** (or Solana). Don't have USDC yet? Any Co ::::tabs :::tab{label="Claude Code (MCP)"} -Best for Claude Code, Cursor, and other MCP clients — natural-language access to all 19 tools. +Best for Claude Code, Cursor, and other MCP clients — natural-language access to all 19 tools. ```bash claude mcp add blockrun -s user -- npx -y @blockrun/mcp@latest diff --git a/docs/mcp/blockrun-mcp.md b/docs/mcp/blockrun-mcp.md index 0280772..bdfb4ee 100644 --- a/docs/mcp/blockrun-mcp.md +++ b/docs/mcp/blockrun-mcp.md @@ -96,7 +96,7 @@ Then send USDC (SPL) on the **Solana** network — from Coinbase (pick "Solana") ## Available Tools -The MCP exposes 19 tools to Claude: +The MCP exposes 19 tools to Claude: ### `blockrun_chat` diff --git a/docs/mcp/skills.md b/docs/mcp/skills.md index b9f7113..2e4247b 100644 --- a/docs/mcp/skills.md +++ b/docs/mcp/skills.md @@ -179,7 +179,7 @@ Generate images via micropayments with the bundled skill. ::: :::card{title="BlockRun MCP" href="blockrun-mcp.md" icon="Boxes"} -The MCP server and the 19 tools skills build on. +The MCP server and the 19 tools skills build on. ::: :::card{title="Troubleshooting" href="troubleshooting.md" icon="Search"} diff --git a/docs/products/franklin.md b/docs/products/franklin.md index e5bd073..960fc95 100644 --- a/docs/products/franklin.md +++ b/docs/products/franklin.md @@ -50,7 +50,7 @@ No install? Run it directly with `npx @blockrun/franklin`. Franklin is the autonomous agent on top of the BlockRun stack — it uses the same pieces you can use directly: -- **Models & routing** — picks the best model per task via [ClawRouter](routing/clawrouter.md)'s scoring, across 66 chat models. +- **Models & routing** — picks the best model per task via [ClawRouter](routing/clawrouter.md)'s scoring, across 66 chat models. - **Paid APIs** — search, market data, media, RPC, and more, paid per call over [x402](../x402/how-it-works.md). - **One wallet** — the wallet is the identity; fund it on Base or Solana ([Wallet Setup](../getting-started/wallet-setup.md)). diff --git a/docs/products/intelligence/overview.md b/docs/products/intelligence/overview.md index acaafba..96426e6 100644 --- a/docs/products/intelligence/overview.md +++ b/docs/products/intelligence/overview.md @@ -101,7 +101,7 @@ The 5% covers: **No subscriptions. No minimums. No prepaid credits.** :::tip{title="Cut costs automatically"} -Don't want to pick models by hand? [ClawRouter](../routing/clawrouter.md) routes each request to the cheapest model that can handle it — 87% lower cost than pinning one flagship for every request. +Don't want to pick models by hand? [ClawRouter](../routing/clawrouter.md) routes each request to the cheapest model that can handle it — 87% lower cost than pinning one flagship for every request. ::: ## Quick Start diff --git a/docs/products/routing/clawrouter.md b/docs/products/routing/clawrouter.md index 081da5f..adbbcc9 100644 --- a/docs/products/routing/clawrouter.md +++ b/docs/products/routing/clawrouter.md @@ -5,7 +5,7 @@ description: ClawRouter is a smart LLM router for OpenClaw that picks the optima # ClawRouter -**87% cheaper than pinning one flagship for every request — 98% on `eco`. Automatically.** +**87% cheaper than pinning one flagship for every request — 98% on `eco`. Automatically.** ClawRouter is a smart LLM router for OpenClaw that routes every request to the cheapest model that can handle it. One wallet, 64 models, zero API keys. diff --git a/docs/resources/ecosystem.md b/docs/resources/ecosystem.md index 73f07e7..fad6089 100644 --- a/docs/resources/ecosystem.md +++ b/docs/resources/ecosystem.md @@ -33,7 +33,7 @@ Projects, integrations, and partners building with BlockRun and x402. | **Search** | `/v1/search` | $0.025/source | ✅ Live | | **Exa Web Search** | `/api/v1/exa/*` | $0.002–0.012 | ✅ Live | | **0x Swap (DEX)** | `/api/v1/zerox/*` | Free | ✅ Live | -| **Multi-chain RPC** | `/api/v1/rpc/{network}` (40 chains) | $0.004/call | ✅ Live | +| **Multi-chain RPC** | `/api/v1/rpc/{network}` (40 chains) | $0.004/call | ✅ Live | | **Prediction Markets** | `/v1/pm/*` | $0.0095 | ✅ Live | | **Trading Markets** | `/api/v1/markets/*` | $0.003 | ✅ Live | | **Modal Sandbox** | `/v1/modal/*` | $0.003–0.012 | ✅ Live | diff --git a/docs/resources/faq.md b/docs/resources/faq.md index 702cc8f..1927dc8 100644 --- a/docs/resources/faq.md +++ b/docs/resources/faq.md @@ -14,7 +14,7 @@ Frequently asked questions about BlockRun — payments, products, models, wallet BlockRun is economic infrastructure for AI agents. It provides: - **Trading** — AI that analyzes markets and executes trades (alpha-mcp) - **Creation** — generate images, video, music, and speech, paid per output -- **Intelligence** — Access to 66 chat/LLM models via x402 micropayments +- **Intelligence** — Access to 66 chat/LLM models via x402 micropayments ### What makes BlockRun different? diff --git a/docs/x402/endpoints.md b/docs/x402/endpoints.md index 60bebdc..c8d652c 100644 --- a/docs/x402/endpoints.md +++ b/docs/x402/endpoints.md @@ -136,7 +136,7 @@ Real-time and historical prices. All `list` endpoints are free. **Crypto, FX, an ## Blockchain RPC (Tatum) -Standard JSON-RPC 2.0 to 40 chains through one endpoint — no API key. EVM (`eth_*`) and non-EVM methods. See [Multi-chain RPC](../api-reference/multi-chain-rpc.md). +Standard JSON-RPC 2.0 to 40 chains through one endpoint — no API key. EVM (`eth_*`) and non-EVM methods. See [Multi-chain RPC](../api-reference/multi-chain-rpc.md). | Method | Path | Purpose | Pricing | |---|---|---|---|