Skip to content

docs: post-#27 follow-up — correctness fixes + Vale prose cleanup#29

Open
alexander-sei wants to merge 2 commits into
mainfrom
docs/review-followup-fixes
Open

docs: post-#27 follow-up — correctness fixes + Vale prose cleanup#29
alexander-sei wants to merge 2 commits into
mainfrom
docs/review-followup-fixes

Conversation

@alexander-sei

Copy link
Copy Markdown
Collaborator

What is the purpose of the change?

Corrects existing documentation. This is a follow-up to the now-merged review in #27 — it resolves a few issues the review surfaced but #27 didn't fully address, and clears the actionable Vale prose-lint findings.

Describe the changes to the documentation

Correctness fixes (89629a8):

  • Gas price: propagate the 0.02usei chain-wide minimum (per the Cosmos chain registry's fixed_min_gas_price and docs: fix factual errors, broken examples, and migrate to Hardhat 3 #27's own note) to the node guides and validator tx examples that still showed 0.01useinode-operators, validators (create-validator + gov vote), seictl, technical-reference. The auto-generated seid init default block is intentionally left untouched.
  • ethers v6: receipt.transactionHashreceipt.hash (4 sites in the bank precompile guide), and rename the mislabeled amountInUsei (it parses 18-decimal wei) to amountInWei.
  • node-operators DB maintenance: reorder the block so the backup runs before the destructive wipe — previously the cp ran after the wipe, copying an empty data dir.
  • Imports: learn/accounts.mdx now imports precompile constants from @sei-js/precompiles (matching every other precompile page) instead of @sei-js/evm.
  • Hardhat: evm-hardhat.mdx uses network.create() (the official Hardhat 3 API) instead of network.getOrCreate().

Vale prose cleanup (eeb292a):

  • Terminology: "gas fees" → "gas" across 17 pages (22 hits); "Metamask" → "MetaMask".
  • Qualifiers: drop filler (really/simply/completely/essentially/very) at 19 sites.
  • Sei.Terminology rule: remove the noisy bare-CWCosmWasm swap. It only fired on legitimate shorthand ("CW pointer", "CW-based", "CW NFT", "CW standards") — CW20/CW721/CW1155 were never matched (the trailing digit blocks the word boundary). CosmWasm casing stays enforced by the [Cc]osmwasm rule.

Notes

  • Verified: vale now reports only the pre-existing sentence-case heading backlog (Sei.Headings), left untouched per the CI's advisory, changed-lines-only policy; typos reports 0.
  • In-code occurrences of "gas fees" (console.log/throw) and the dev-gas SEO keyword are intentionally preserved.
  • Rebased onto current main (clean — no overlap with the llms.txt regeneration).

🤖 Generated with Claude Code

alexander-sei and others added 2 commits June 16, 2026 12:12
… imports

Follow-up fixes from the PR #27 review:

- Gas price: propagate the 0.02usei chain-wide minimum (per the Cosmos chain
  registry's fixed_min_gas_price and PR #27's own note) to the node guides and
  validator tx examples that still showed 0.01usei — node-operators.mdx,
  validators.mdx (create-validator + gov vote), seictl.mdx, technical-reference.mdx.
  index.mdx was already updated in #27. The auto-generated app.toml default block
  is left untouched (it reflects `seid init` output).
- bank.mdx: ethers v6 receipts expose `.hash`, not `.transactionHash` (4 sites);
  also rename the mislabeled `amountInUsei` (actually 18-decimal wei) to
  `amountInWei` in the sendNative helper.
- node-operators.mdx: reorder the DB-maintenance block so the backup runs BEFORE
  the destructive wipe — previously the `cp` ran after the wipe, copying an empty
  data dir.
- accounts.mdx: import precompile constants from @sei-js/precompiles (matches every
  other precompile page) instead of @sei-js/evm.
- evm-hardhat.mdx: use network.create() (the official Hardhat 3 API) instead of
  network.getOrCreate(), aligning with the pages migrated in #27.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Clears the actionable Vale findings (typos/spelling was already clean):

- Terminology: "gas fees" -> "gas" across 17 prose pages (22 hits) and
  "Metamask" -> "MetaMask" (sei-global-wallet.mdx). In-code occurrences
  (console.log/throw) and the dev-gas SEO keyword are intentionally left.
- Qualifiers: drop filler ("really"/"simply"/"completely"/"essentially"/
  "very") at 19 sites where it added nothing.
- Sei.Terminology rule: remove the bare '\bCW\b' -> CosmWasm swap. It only
  fired on legitimate shorthand ("CW pointer", "CW-based", "CW NFT", "CW
  standards") — CW20/CW721/CW1155 were never matched (the trailing digit
  blocks the word boundary). CosmWasm casing stays enforced by [Cc]osmwasm.

Vale now reports only the pre-existing sentence-case heading backlog
(Sei.Headings, 1369), left untouched per the CI's advisory policy.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@cursor

cursor Bot commented Jun 16, 2026

Copy link
Copy Markdown

PR Summary

Low Risk
Documentation and lint-rule changes only; no runtime code. Operators copying updated examples may see different (correct) gas settings and Hardhat/ethers patterns.

Overview
Follow-up to #27: correctness fixes across node/EVM/learn guides plus Vale-driven prose updates.

Correctness: Node and validator docs now use 0.02usei for mainnet minimum gas (with a note on chain-wide enforcement) in app.toml examples, seictl patches, and --gas-prices CLI samples. evm-hardhat.mdx switches Hardhat 3 samples from network.getOrCreate() to network.create(). learn/accounts.mdx imports precompile constants from @sei-js/precompiles instead of @sei-js/evm. The bank precompile guide uses ethers v6 receipt.hash and renames amountInUseiamountInWei. node-operators.mdx database maintenance now backs up before the destructive wipe.

Prose / lint: Vale Sei.Terminology drops the bare CW → CosmWasm rule (with a comment that CW shorthand is intentional). Widespread “gas fees” → “gas”, MetaMask casing, and trimming filler words (simply, really, etc.) across many MDX pages.

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

@mintlify

mintlify Bot commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
sei-docs 🟢 Ready View Preview Jun 16, 2026, 10:26 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