docs: agent & developer onboarding improvements (RPC discoverability, quickstarts, tx fix)#13
Conversation
Improvements surfaced by an AI-agent documentation scan:
- learn/dev-chains: list EVM RPC, WebSocket, and explorer endpoints in
plain text (they were previously only rendered inside a JS widget, so
non-JS readers and agents couldn't see them)
- evm/index: replace the RPC-selector iframe with a native endpoint table
so endpoints are readable without executing JavaScript
- evm/transactions: fix the web3.js "send a transaction" sample to sign
locally and broadcast the raw transaction — public RPC endpoints don't
expose node-managed accounts, so getAccounts()/eth_sendTransaction can't
run as written
- evm/evm-parity/examples/{ethers,viem}-quickstart: show expected stdout
and add a Python (web3.py) snippet
- evm/building-a-frontend: link the contract-deploy step where
TOKEN_CONTRACT_ADDRESS is introduced
- docs.json: redirect /learn/getting-started and /evm/getting-started to /learn
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
PR SummaryLow Risk Overview Discoverability: Correctness: The web3.js example in Quickstarts & guides: Ethers and viem quickstarts add a no-key read milestone, expected stdout, faucet notes for sends, and a short web3.py section. The frontend guide links deploy paths (Hardhat, Foundry, wizard) where Reviewed by Cursor Bugbot for commit 9e2c32d. Bugbot is set up for automated code reviews on this repo. Configure here. |
Summary
Improvements surfaced by an AI-agent scan of the docs. The recurring theme was that key information (RPC endpoints) was only available inside JavaScript widgets — invisible to non-JS readers and AI agents — plus one runnable-code bug.
What's changed
Discoverability
learn/dev-chains— EVM RPC, WebSocket, and explorer endpoints are now listed in plain text alongside the existing "add to wallet" widgets.evm/index— the RPC-selector iframe is replaced with a native endpoint table (official + community endpoints, per network), readable without executing JavaScript.docs.json—/learn/getting-startedand/evm/getting-started(common guessed URLs that 404'd) now redirect to/learn.Correctness
evm/transactions— the only end-to-end "send a transaction" sample usedweb3.eth.getAccounts()+eth_sendTransaction, which public RPC endpoints don't support (they don't expose node-managed accounts), so it couldn't run as written. Replaced with local signing (privateKeyToAccount→signTransaction→sendSignedTransaction) using current web3.js v4 APIs.Completeness
evm/evm-parity/examples/ethers-quickstart&viem-quickstart— each read example now shows expected stdout ("You're done when you see…"), labels the credential-free read path as the first milestone, and adds a short Python (web3.py) snippet since Sei is EVM-compatible.evm/building-a-frontend— the contract-deploy prerequisite is now linked inline whereTOKEN_CONTRACT_ADDRESSis introduced (Hardhat / Foundry / wizard).Testing
mint broken-linkspasses.mint dev.All endpoint values and chain IDs are taken verbatim from the existing network widgets /
llms.txt.🤖 Generated with Claude Code