docs: post-#27 follow-up — correctness fixes + Vale prose cleanup#29
docs: post-#27 follow-up — correctness fixes + Vale prose cleanup#29alexander-sei wants to merge 2 commits into
Conversation
… 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>
PR SummaryLow Risk Overview Correctness: Node and validator docs now use Prose / lint: Vale Reviewed by Cursor Bugbot for commit eeb292a. Bugbot is set up for automated code reviews on this repo. Configure here. |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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):0.02useichain-wide minimum (per the Cosmos chain registry'sfixed_min_gas_priceand 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 showed0.01usei—node-operators,validators(create-validator + gov vote),seictl,technical-reference. The auto-generatedseid initdefault block is intentionally left untouched.receipt.transactionHash→receipt.hash(4 sites in the bank precompile guide), and rename the mislabeledamountInUsei(it parses 18-decimal wei) toamountInWei.cpran after the wipe, copying an empty data dir.learn/accounts.mdxnow imports precompile constants from@sei-js/precompiles(matching every other precompile page) instead of@sei-js/evm.evm-hardhat.mdxusesnetwork.create()(the official Hardhat 3 API) instead ofnetwork.getOrCreate().Vale prose cleanup (
eeb292a):really/simply/completely/essentially/very) at 19 sites.Sei.Terminologyrule: remove the noisy bare-CW→CosmWasmswap. It only fired on legitimate shorthand ("CW pointer", "CW-based", "CW NFT", "CW standards") —CW20/CW721/CW1155were never matched (the trailing digit blocks the word boundary). CosmWasm casing stays enforced by the[Cc]osmwasmrule.Notes
valenow reports only the pre-existing sentence-case heading backlog (Sei.Headings), left untouched per the CI's advisory, changed-lines-only policy;typosreports 0.console.log/throw) and thedev-gasSEO keyword are intentionally preserved.main(clean — no overlap with thellms.txtregeneration).🤖 Generated with Claude Code