Repository navigation
docs: use Sei Mainnet and Sei Testnet naming #79
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
f72ede1
673fbc4
7442b55
b59f5a9
05e72a1
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,6 +10,15 @@ action: | |
| swap: | ||
| 'the Sei blockchain': Sei | ||
| 'Sei [Cc]hain': Sei | ||
| # Capitalized forms are reader-facing prose; the lowercase literals | ||
| # 'pacific-1' and 'atlantic-2' are intentionally kept for CLI, config, | ||
| # registry keys, and API paths, and don't match here (ignorecase: false). | ||
| 'Pacific-1': Sei Mainnet | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [suggestion] This new rule is already violated by a leftover in the repo —
That's reader-facing prose, exactly the case this PR is converting. It slipped through the stated |
||
| 'Atlantic-2': Sei Testnet | ||
| # The network names are proper nouns, so the lowercase prose forms are wrong | ||
| # too. 'Sei Mainnet' and 'Sei Testnet' never match these patterns. | ||
| 'Sei mainnet': Sei Mainnet | ||
| 'Sei testnet': Sei Testnet | ||
| 'gas fees?': gas | ||
| # Bare 'CW' is accepted shorthand for CosmWasm here — the standard names | ||
| # CW20/CW721/CW1155 plus phrases like "CW pointer", "CW-based", and "CW NFT". | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| # Sei Docs — agent instructions | ||
|
|
||
| ## About this project | ||
|
|
||
|
|
@@ -14,11 +14,11 @@ | |
| - **Sei Giga** is the next-generation architecture upgrade | ||
| - **seid** is the CLI binary; always lowercase and code-formatted | ||
| - **sei-js** (lowercase, hyphenated) for the JS/TS SDK | ||
| - **Pacific-1** (mainnet chain ID `1329`), **Atlantic-2** (testnet chain ID `1328`) | ||
| - Use **Sei Mainnet** (EVM chain ID `1329`) and **Sei Testnet** (EVM chain ID `1328`) in reader-facing copy. Both are proper nouns, so "Sei mainnet" and "Sei testnet" are wrong. Keep the literal identifiers `pacific-1` (mainnet) and `atlantic-2` (testnet) only where technically required, especially in node-operator instructions, CLI or config values, API paths, and registry keys. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [nit] This line states the rule using the forbidden forms in plain prose: Wrapping them in backticks (
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [nit] This added line contains the literal strings More practically: the rule carries |
||
| - Precompiles live at specific addresses — always reference exact address when mentioning | ||
| - **Twin Turbo Consensus** and **parallelization engine** are proper nouns | ||
| - Prefer "dApp" over "app" when the context is blockchain | ||
| - Avoid "gas fees" — say "gas" or "transaction fees" | ||
|
|
||
| ## Style preferences | ||
|
|
||
|
|
@@ -46,7 +46,7 @@ | |
|
|
||
| All legacy paths from the Nextra site are preserved in `docs.json` under `redirects`. When renaming or moving a page, always add a matching redirect entry so external links and search results continue to resolve. | ||
|
|
||
| ## llms.txt / llms-full.txt | ||
|
|
||
| `llms.txt` and `llms-full.txt` at the repo root are hand-curated overrides for Mintlify's auto-generated versions. The script `scripts/generate-llms.mjs` reads `docs.json`, fetches each page's `.md` from the deployed site, and re-emits both files using the curated config block at the top of the script (project name, intro, constraints, quick reference, section overviews, examples, resources). A scheduled GitHub Action (`.github/workflows/regenerate-llms.yml`) runs this weekly and opens a PR when anything changed; trigger it manually via `workflow_dispatch` after large content updates if you don't want to wait. Edit the config block at the top of the script to update wording; do not hand-edit the generated `.txt` files. | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| # Sei Docs Style Guide | ||
|
|
||
| This style guide contains general rules and principles to ensure the documentation is cohesive, useful, and organized. | ||
|
|
||
|
|
@@ -6,7 +6,7 @@ | |
|
|
||
| This documentation strives to be: | ||
|
|
||
| ### Beginner Friendly | ||
|
|
||
| The Sei community welcomes members from all walks of life. As such, the documentation should be understandable by anyone, including those who are new to Web3 or non-technical. | ||
|
|
||
|
|
@@ -22,8 +22,8 @@ | |
|
|
||
| - To be clear and inclusive, avoid using jargon and obscure words where possible. | ||
| - Limit the number of clauses in a sentence and make sure that your points are structured. | ||
| - Avoid qualifying language, which is ~~quite~~ often ~~completely~~ unnecessary. | ||
|
Check warning on line 25 in STYLE_GUIDE.md
|
||
| - Information should be simply organized and easy to find. | ||
|
|
||
| ### Self-explanatory | ||
|
|
||
|
|
@@ -64,13 +64,13 @@ | |
| - **Reference**: Transactions, RPC reference, tokens, changelog, ecosystem contracts | ||
| - **Hardware Wallets**: Ledger integration with Ethers | ||
|
|
||
| ### Cosmos-SDK (Deprecated) | ||
|
|
||
| > ⚠️ **Deprecation Notice**: Cosmos SDK and CosmWasm functionality is being deprecated in favor of EVM-only. For more details, see [SIP-3](https://github.com/sei-protocol/sips/blob/main/sips/sip-3.md) and [Proposal 99](https://seistream.app/proposals/99). | ||
|
|
||
| This section contains legacy documentation for Cosmos SDK functionality. New development should focus on the EVM. | ||
|
|
||
| ### Operate (Node) | ||
|
|
||
| The Operate section covers topics related to running Sei infrastructure. This is relevant for node operators, validators, and those looking to contribute to chain infrastructure. | ||
|
|
||
|
|
@@ -79,15 +79,15 @@ | |
| - **Node Operations**: Overview, Seictl setup, statesync, snapshot sync, node types, troubleshooting, API configuration, validators, oracle price feeder | ||
| - **Advanced Operations**: Configuration & monitoring, Giga SS Store migration, technical reference | ||
|
|
||
| ## Style Guidelines | ||
|
|
||
| ### Acronyms and Abbreviations | ||
|
|
||
| To maximize clarity, we should avoid acronyms and abbreviations where possible, especially for shorter, more ambiguous acronyms: | ||
|
|
||
| - Just use 'CosmWasm' instead of 'CW' | ||
|
|
||
| However, there are occasions where acronyms might be more easily understandable (e.g., NFT instead of Non-Fungible Token, RPC instead of Remote Procedure Call), or referred to very frequently. | ||
|
|
||
| In these cases, we should first use the spelled-out term followed by the shortened form in parentheses: | ||
|
|
||
|
|
@@ -252,7 +252,7 @@ | |
| </Frame> | ||
| ``` | ||
|
|
||
| ### Callouts and Admonitions | ||
|
|
||
| Use callouts to highlight important information. Mintlify supports the following callout types: | ||
|
|
||
|
|
@@ -285,12 +285,13 @@ | |
|
|
||
| When referencing network information, always include: | ||
|
|
||
| - Chain ID (both decimal and hex format where applicable) | ||
| - EVM chain ID (both decimal and hex format where applicable) | ||
| - Cosmos chain ID (`pacific-1`, `atlantic-2`) when the table documents `seid` or Cosmos endpoints | ||
| - RPC URLs | ||
| - Explorer links | ||
|
|
||
| Example: | ||
| | Network | Chain ID | RPC URL | | ||
| | Network | EVM chain ID | RPC URL | | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [nit] The example column is now "EVM chain ID", but the guidance bullet a few lines above (line 288) still reads "Chain ID (both decimal and hex format where applicable)". Worth updating that bullet to match so the instruction and its example agree — especially since the whole point of this PR is disambiguating EVM chain IDs from Cosmos chain IDs. |
||
| |---------|----------|---------| | ||
| | Mainnet (pacific-1) | 1329 (0x531) | https://evm-rpc.sei-apis.com | | ||
| | Testnet (atlantic-2) | 1328 (0x530) | https://evm-rpc-testnet.sei-apis.com | | ||
| | Sei Mainnet | 1329 (0x531) | https://evm-rpc.sei-apis.com | | ||
| | Sei Testnet | 1328 (0x530) | https://evm-rpc-testnet.sei-apis.com | | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[suggestion] The comment above this ("A colon starts a new sentence") overstates what
indicatorsdoes. Vale documents it as a list of suffixes after which the next token is ignored — so it exempts exactly one word following the colon, not the remainder of the heading.## Step 1: Evaluate compatibilitypasses either way, but## Step 1: Evaluate Compatibilitywould still be flagged onCompatibility, which is probably the behavior you want; the comment just implies something broader.One thing I couldn't verify locally (no Vale binary available in this environment): whether
indicatorsis honored formatch: $sentenceor only for$title. Since you validated against Vale 3.14.2 directly, you're better placed to confirm; if it's a no-op for$sentence, this key is dead config. Either way the rule is warning-level and never fails the build, so it's low risk.