Skip to content

docs: agent & developer onboarding improvements (RPC discoverability, quickstarts, tx fix)#13

Merged
alexander-sei merged 1 commit into
mainfrom
docs-improvements
May 30, 2026
Merged

docs: agent & developer onboarding improvements (RPC discoverability, quickstarts, tx fix)#13
alexander-sei merged 1 commit into
mainfrom
docs-improvements

Conversation

@alexander-sei
Copy link
Copy Markdown
Collaborator

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-started and /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 used web3.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 (privateKeyToAccountsignTransactionsendSignedTransaction) 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 where TOKEN_CONTRACT_ADDRESS is introduced (Hardhat / Foundry / wizard).

Testing

  • mint broken-links passes.
  • All changed pages compile and render under mint dev.

All endpoint values and chain IDs are taken verbatim from the existing network widgets / llms.txt.

🤖 Generated with Claude Code

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>
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 30, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
sei-docs 🟢 Ready View Preview May 30, 2026, 12:47 PM

@cursor
Copy link
Copy Markdown

cursor Bot commented May 30, 2026

PR Summary

Low Risk
Documentation and redirect-only changes; no application code, auth, or on-chain behavior.

Overview
This PR improves developer and agent onboarding by surfacing network and RPC details in plain text and fixing a misleading transaction sample.

Discoverability: learn/dev-chains now lists EVM RPC, WebSocket, and explorer URLs for mainnet and testnet. On evm/index, the RPC-selector iframe is replaced with mainnet/testnet endpoint tables (official and community URLs, rate limits), plus links to dedicated RPC providers and running a node. docs.json adds permanent redirects from /learn/getting-started and /evm/getting-started to /learn.

Correctness: The web3.js example in evm/transactions no longer uses getAccounts / eth_sendTransaction (unsupported on public RPC). It documents local signing with web3.js v4, chainId, and sendSignedTransaction, with an Info callout explaining the limitation.

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 TOKEN_CONTRACT_ADDRESS is introduced.

Reviewed by Cursor Bugbot for commit 9e2c32d. Bugbot is set up for automated code reviews on this repo. Configure here.

@alexander-sei alexander-sei merged commit 7e01b1a into main May 30, 2026
6 checks passed
@alexander-sei alexander-sei deleted the docs-improvements branch May 30, 2026 13:22
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