Skip to content

docs: fix accuracy & consistency issues across EVM and Learn docs#21

Merged
alexander-sei merged 1 commit into
mainfrom
docs/dev-docs-review-fixes
Jun 3, 2026
Merged

docs: fix accuracy & consistency issues across EVM and Learn docs#21
alexander-sei merged 1 commit into
mainfrom
docs/dev-docs-review-fixes

Conversation

@alexander-sei
Copy link
Copy Markdown
Collaborator

What is the purpose of the change?

Correct existing documentation. This is a review pass that fixes small, concrete accuracy and consistency issues — no new content and no deletions.

Describe the changes to the documentation

  • Gas — minimum gas price (differences-with-ethereum): resolves a direct contradiction (one page said legacy txs need 10 gwei, others said 50 gwei). Now points to the governance-set floor (50 gwei) and tells devs to query eth_gasPrice. Verified against live mainnet: eth_gasPrice returns 55 gwei (50 gwei floor + tip).
  • Ethereum comparison numbers (evm/index, migrate-from-other-evms): Ethereum throughput corrected to ~5 MGas/s and block time to ~12 s (60M block gas limit / 12s slots, post-Fusaka), and the throughput multiplier recomputed to 20× (100 ÷ 5). Sei stays at 100 MGas/s.
  • Finality terminology: standardized on the existing dominant term "instant finality", and comparison tables now show "Instant (~400 ms)" consistently (differences-with-ethereum, reference, migrate-from-other-evms).
  • Native token labels (dev-gas, transactions-with-seid): relabel ETHSEI in examples/flag descriptions.
  • Accounts (learn/accounts): intro now clarifies that the two addresses hold separate balances until association, instead of implying they are always unified.
  • Explorer name: standardize SeitraceSeiscan (ai/sei-skill/*, cambrian-agent-kit).
  • Hardhat (evm-verify-contracts): align the keystore variable to SEI_PRIVATE_KEY so it matches the deploy tutorial.
  • wagmi (dev-gas): update the sendTransaction snippet to the wagmi v2 API (@wagmi/core, config-first, parseEther/parseGwei, gas not gasLimit).

Target audience: EVM developers building/migrating to Sei.

Notes

  • typos passes on all changed files.
  • A separately flagged item — keyword strings appearing glued to headings — was investigated and traced to the Mintlify search-index representation, not the source .mdx or generated llms-full.txt (both are clean). Intentionally no change here; the keywords frontmatter is valid SEO metadata.
  • llms.txt / llms-full.txt are generated from these sources and are not regenerated in this PR. If a refresh is required before merge, run the repo's generation step (scripts/generate-llms.mjs) — happy to add that as a follow-up commit.

🤖 Generated with Claude Code

Small, concrete corrections from a documentation review pass:

- Gas: resolve the 10 vs 50 gwei minimum-gas-price contradiction; point to
  the governance-set floor and eth_gasPrice (verified live on mainnet:
  eth_gasPrice = 55 gwei = 50 gwei floor + tip).
- Ethereum comparison: correct throughput to ~5 MGas/s and block time to
  ~12 s (60M block gas limit / 12s slots) and recompute the throughput
  multiplier to 20x (100 / 5).
- Finality: standardize on the existing dominant term "instant finality"
  and show "Instant (~400 ms)" consistently in comparison tables.
- Native token: relabel ETH -> SEI in the gas and seid examples.
- Accounts: clarify that the two addresses hold separate balances until
  association.
- Explorer: standardize Seitrace -> Seiscan.
- Hardhat: align the keystore variable to SEI_PRIVATE_KEY between the deploy
  and verify guides.
- wagmi: update the sendTransaction snippet to the wagmi v2 API (@wagmi/core,
  config-first, parseEther/parseGwei, gas not gasLimit).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@cursor
Copy link
Copy Markdown

cursor Bot commented Jun 3, 2026

PR Summary

Low Risk
Markdown documentation and code-sample edits only; no runtime, auth, or on-chain behavior changes.

Overview
This PR is a documentation accuracy pass across EVM and Learn pages—no new features, only wording and example fixes.

Gas and Ethereum comparisons: differences-with-ethereum now documents legacy transactions against Sei’s governance minimum gas price (~50 gwei) and tells developers to use eth_gasPrice instead of the outdated 10 gwei figure. evm/index and migrate-from-other-evms update Ethereum to ~12 s blocks and ~5 MGas/s throughput and reframe the Sei advantage as ~20× (not 33×).

Finality and tokens: Comparison tables and prose consistently use “Instant (~400 ms)” where instant finality is described. Examples that said ETH for native value are relabeled SEI in dev-gas and transactions-with-seid.

Accounts, tooling, and branding: learn/accounts clarifies that 0x… and sei1… keep separate balances until association. Hardhat verify config uses SEI_PRIVATE_KEY to match deploy docs; the wagmi snippet in dev-gas is updated to wagmi v2 (@wagmi/core, parseEther/parseGwei). Explorer references are standardized from Seitrace to Seiscan in AI/sei-skill and Cambrian agent kit pages.

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

@alexander-sei alexander-sei merged commit 7477eee into main Jun 3, 2026
8 checks passed
@alexander-sei alexander-sei deleted the docs/dev-docs-review-fixes branch June 3, 2026 10:55
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented Jun 3, 2026

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

Project Status Preview Updated (UTC)
sei-docs 🔴 Failed Jun 3, 2026, 11:00 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

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