Skip to content

docs: align sei-js references with current packages #67

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.

Sign up for GitHub

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

Merged
alexander-sei merged 7 commits into from
Aug 28, 2026
Merged

docs: align sei-js references with current packages #67

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c68b3ff
Update docs: MCP server, @sei-js and precompiles
alexander-sei Aug 18, 2026
8ef5b98
docs: address sei-js review feedback
alexander-sei Aug 18, 2026
dd059da
Merge branch 'main' into docs/incorporate-sei-js-changes
alexander-sei Aug 20, 2026
371ec54
Refresh Sei docs for ESM and MCP
alexander-sei Aug 26, 2026
45597ea
docs: resolve seidroid review feedback on sei-js alignment
alexander-sei Aug 27, 2026
17b19a2
docs: repair redirect entries that never resolved
alexander-sei Aug 27, 2026
b45bfcd
Update x402 docs for v2 and deprecations
alexander-sei Aug 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion STYLE_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sei Docs Style Guide

Check warning on line 1 in STYLE_GUIDE.md

View check run for this annotation

Mintlify / Mintlify Validation (seilabs) - vale-spellcheck

STYLE_GUIDE.md#L1 

Use sentence case for headings: 'Sei Docs Style Guide'.

This style guide contains general rules and principles to ensure the documentation is cohesive, useful, and organized.

Expand All @@ -6,7 +6,7 @@

This documentation strives to be:

### Beginner Friendly

Check warning on line 9 in STYLE_GUIDE.md

View check run for this annotation

Mintlify / Mintlify Validation (seilabs) - vale-spellcheck

STYLE_GUIDE.md#L9 

Use sentence case for headings: '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.

Expand All @@ -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

View check run for this annotation

Mintlify / Mintlify Validation (seilabs) - vale-spellcheck

STYLE_GUIDE.md#L25 

'quite' is often unnecessary qualifying language — consider removing it.

Check warning on line 25 in STYLE_GUIDE.md

View check run for this annotation

Mintlify / Mintlify Validation (seilabs) - vale-spellcheck

STYLE_GUIDE.md#L25 

'completely' is often unnecessary qualifying language — consider removing it.
- Information should be simply organized and easy to find.

Check warning on line 26 in STYLE_GUIDE.md

View check run for this annotation

Mintlify / Mintlify Validation (seilabs) - vale-spellcheck

STYLE_GUIDE.md#L26 

'simply' is often unnecessary qualifying language — consider removing it.

### Self-explanatory

Expand Down Expand Up @@ -59,18 +59,18 @@
- **seid CLI**: Installation, querying, and transactions
- **Frontend Development**: Sei Global Wallet, building frontends
- **Smart Contracts**: Development with Hardhat/Foundry, contract wizard, debugging, tracing, verification, precompiles
- **sei-js Library**: External links to sei-js documentation (Scaffold Sei, MCP Server, X402, Ledger)
- **Developer tooling**: sei-js packages, Scaffold Sei, MCP Server, x402, and Ledger
- **Ecosystem Tutorials**: Indexers, wallet integrations, bridging, AI tooling, oracles, VRF
- **Reference**: Transactions, RPC reference, tokens, changelog, ecosystem contracts
- **Hardware Wallets**: Ledger integration with Ethers

### Cosmos-SDK (Deprecated)

Check warning on line 67 in STYLE_GUIDE.md

View check run for this annotation

Mintlify / Mintlify Validation (seilabs) - vale-spellcheck

STYLE_GUIDE.md#L67 

Use sentence case for headings: '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)

Check warning on line 73 in STYLE_GUIDE.md

View check run for this annotation

Mintlify / Mintlify Validation (seilabs) - vale-spellcheck

STYLE_GUIDE.md#L73 

Use sentence case for headings: '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.

Expand All @@ -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

Check warning on line 82 in STYLE_GUIDE.md

View check run for this annotation

Mintlify / Mintlify Validation (seilabs) - vale-spellcheck

STYLE_GUIDE.md#L82 

Use sentence case for headings: 'Style Guidelines'.

### Acronyms and Abbreviations

Check warning on line 84 in STYLE_GUIDE.md

View check run for this annotation

Mintlify / Mintlify Validation (seilabs) - vale-spellcheck

STYLE_GUIDE.md#L84 

Use sentence case for headings: '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.

Check warning on line 90 in STYLE_GUIDE.md

View check run for this annotation

Mintlify / Mintlify Validation (seilabs) - vale-spellcheck

STYLE_GUIDE.md#L90 

'very' is often unnecessary qualifying language — consider removing it.

In these cases, we should first use the spelled-out term followed by the shortened form in parentheses:

Expand Down Expand Up @@ -252,7 +252,7 @@
</Frame>
```

### Callouts and Admonitions

Check warning on line 255 in STYLE_GUIDE.md

View check run for this annotation

Mintlify / Mintlify Validation (seilabs) - vale-spellcheck

STYLE_GUIDE.md#L255 

Use sentence case for headings: 'Callouts and Admonitions'.

Use callouts to highlight important information. Mintlify supports the following callout types:

Expand Down
354 changes: 204 additions & 150 deletions ai/mcp-server.mdx
View file
Open in desktop

Large diffs are not rendered by default.

570 changes: 225 additions & 345 deletions ai/x402.mdx
View file
Open in desktop

Large diffs are not rendered by default.

62 changes: 48 additions & 14 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,6 @@
"pages": [
"evm/sei-js/index",
"evm/sei-js/create-sei",
"evm/sei-js/ledger",
"evm/sei-js/registry"
]
},
Expand Down Expand Up @@ -1268,6 +1267,11 @@
"destination": "/evm/ledger-ethers",
"permanent": true
},
{
"source": "/evm/sei-js/ledger",
"destination": "/evm/ledger-ethers",
"permanent": true
},
{
"source": "/dev-ecosystem-providers/wallets",
"destination": "/learn/wallets",
Expand Down Expand Up @@ -1579,27 +1583,62 @@
"permanent": true
},
{
"source": "/:os(Users|home|root|etc|var|usr|tmp|dev)/:rest*",
"source": "/Users/*",
"destination": "/node/troubleshooting",
"permanent": true
},
{
"source": "/home/*",
"destination": "/node/troubleshooting",
"permanent": true
},
{
"source": "/root/*",
"destination": "/node/troubleshooting",
"permanent": true
},
{
"source": "/etc/*",
"destination": "/node/troubleshooting",
"permanent": true
},
{
"source": "/var/*",
"destination": "/node/troubleshooting",
"permanent": true
},
{
"source": "/usr/*",
"destination": "/node/troubleshooting",
"permanent": true
},
{
"source": "/sei-config-:rest(.*)",
"source": "/tmp/*",
"destination": "/node/troubleshooting",
"permanent": true
},
{
"source": "/dev/*",
"destination": "/node/troubleshooting",
"permanent": true
},
{
"source": "/sei-config-*",
"destination": "/node",
"permanent": true
},
{
"source": "/sei-data-:rest(.*)",
"source": "/sei-data-*",
"destination": "/node",
"permanent": true
},
{
"source": "/sei-backup-:rest(.*)",
"source": "/sei-backup-*",
"destination": "/node/troubleshooting",
"permanent": true
},
{
"source": "/priv_validator_:rest(.*)",
"source": "/priv_validator_*",
"destination": "/node",
"permanent": true
},
Expand Down Expand Up @@ -1635,12 +1674,12 @@
},
{
"source": "/agents",

@seidroid seidroid Bot Aug 27, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[suggestion] Dropping /agents.md entirely is a bit of a shame — it's becoming the conventional URL for agent-facing instructions, and this is the one place it plausibly gets requested from outside.

If the diagnosis in the PR body is right (Mintlify appends .md to a redirect whose source ends in .md), then the fix isn't "delete the entry" — it's to point the source at the extensionless destination and let Mintlify append:

{ "source": "/agents.md", "destination": "/skill", "permanent": true }

Worth one probe against mint dev before merging; if it resolves to /skill.md, you recover the URL for free. Same trick would apply to the removed /llms/skill.md entry.

"destination": "/llms/agents.md",
"destination": "/skill.md",
"permanent": true
},
{
"source": "/agents.md",
"destination": "/llms/agents.md",
"source": "/llms/agents",

@seidroid seidroid Bot Aug 27, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nit] With /agents.md and /llms/skill.md dropped as redirect sources and llms/agents.md / llms/skill.md deleted from the tree, there is now no .md-suffixed path other than /skill.md itself. Agent tooling commonly fetches <host>/agents.md by convention. The PR argues these already 404'd due to Mintlify's .md suffixing, which is fine — but it's worth a post-deploy check that https://docs.sei.io/agents.md behaves acceptably, since it's the path most agents will try first.

"destination": "/skill.md",
"permanent": true
},
{
Expand All @@ -1652,11 +1691,6 @@
"source": "/llms/skill",
"destination": "/skill.md",
"permanent": true
},
{
"source": "/llms/skill.md",
"destination": "/skill.md",
"permanent": true
}
],
"interaction": {
Expand Down
Loading
Loading