Skip to content

docs: Cookbook tab with six recipes, plus event and Foundry fixes #91

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

Open
alexander-sei wants to merge 16 commits into
base: main
Choose a base branch
from
Open

docs: Cookbook tab with six recipes, plus event and Foundry fixes #91

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
1fca868
docs(cookbook): add a Cookbook tab with six task recipes
alexander-sei Oct 2, 2026
e4f950f
docs(examples): watch events over WebSocket and bound log queries
alexander-sei Oct 2, 2026
b352221
docs(foundry): pass --broadcast to forge create
alexander-sei Oct 2, 2026
7baa037
docs(cookbook): restore the recipes' original wording
alexander-sei Oct 4, 2026
f565cc3
docs(cookbook): run top-level await examples as .mts files
alexander-sei Oct 4, 2026
a519486
docs(cookbook): write the OpenZeppelin remappings to remappings.txt
alexander-sei Oct 4, 2026
bee848f
docs(pimlico): append the generated key to .env instead of overwritin…
alexander-sei Oct 4, 2026
9275f0e
docs(pyth): require a Pyth API key and use the upgraded Sei Mainnet c…
alexander-sei Oct 4, 2026
1bda1f9
docs(examples): close the WebSocket provider when a watcher stops
alexander-sei Oct 4, 2026
1c6e52a
docs(cookbook): checksum user-supplied addresses in the web3.py examples
alexander-sei Oct 4, 2026
42801c6
docs(oracles): avoid point-in-time wording and check for PYTH_API_KEY
alexander-sei Oct 4, 2026
5f417aa
docs(examples): show watcher cleanup as a comment
alexander-sei Oct 4, 2026
21aec1c
docs(foundry): say where --constructor-args goes in forge create
alexander-sei Oct 4, 2026
5a18ce3
docs(examples): import webSocket with the other viem helpers
alexander-sei Oct 4, 2026
28a3770
docs: match the Remix sandbox to the shown contract and link the Pyth…
alexander-sei Oct 4, 2026
0d78c93
docs(cookbook): apply ASD-STE100 to the prose in this PR
alexander-sei Oct 4, 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
16 changes: 14 additions & 2 deletions 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 All @@ -33,7 +33,7 @@

## Organization

The Sei Docs are structured using [Mintlify](https://mintlify.com). The documentation is organized into four main sections based on target audience and purpose.
The Sei Docs are structured using [Mintlify](https://mintlify.com). The documentation is organized into tabs based on target audience and purpose.

### Learn

Expand Down Expand Up @@ -64,13 +64,25 @@
- **Reference**: Transactions, RPC reference, tokens, changelog, ecosystem contracts
- **Hardware Wallets**: Ledger integration with Ethers

### Cookbook

The Cookbook tab holds short, task-focused recipes, such as "Read a balance", "Send SEI", and "Listen to events". Each recipe does one task from start to finish. Put new recipes in `evm/cookbook/`. The older example pages stay in `evm/evm-parity/examples/` so that their URLs do not change.

When you write a recipe:

- Show the same code in viem, ethers, and web3.py where the task allows it. Label the `<CodeGroup>` tabs exactly `viem`, `ethers`, and `web3.py`, so that the tabs on a page stay in sync.
- Use Sei Testnet for anything that sends a transaction.
- When a read-only JSON-RPC call shows the result live, add a `<RunSnippet>`.
- If a TypeScript example uses top-level `await`, tell readers to run it as a `.mts` file with `npx tsx`. In a new npm project, `tsx` compiles a plain `.ts` file as CommonJS, where top-level `await` fails.
- End with a "You are done when you see" block that shows the expected output.

### Cosmos-SDK (Deprecated)

Check warning on line 79 in STYLE_GUIDE.md

View check run for this annotation

Mintlify / Mintlify Validation (seilabs) - vale-spellcheck

STYLE_GUIDE.md#L79 

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.
The Learn tab lists the single deprecation page, `cosmos-sdk/index.mdx`, next to the SIP-03 migration guides. New development should focus on the EVM.

### Operate (Node)

Check warning on line 85 in STYLE_GUIDE.md

View check run for this annotation

Mintlify / Mintlify Validation (seilabs) - vale-spellcheck

STYLE_GUIDE.md#L85 

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 +91,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 94 in STYLE_GUIDE.md

View check run for this annotation

Mintlify / Mintlify Validation (seilabs) - vale-spellcheck

STYLE_GUIDE.md#L94 

Use sentence case for headings: 'Style Guidelines'.

### Acronyms and Abbreviations

Check warning on line 96 in STYLE_GUIDE.md

View check run for this annotation

Mintlify / Mintlify Validation (seilabs) - vale-spellcheck

STYLE_GUIDE.md#L96 

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 102 in STYLE_GUIDE.md

View check run for this annotation

Mintlify / Mintlify Validation (seilabs) - vale-spellcheck

STYLE_GUIDE.md#L102 

'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 +264,7 @@
</Frame>
```

### Callouts and Admonitions

Check warning on line 267 in STYLE_GUIDE.md

View check run for this annotation

Mintlify / Mintlify Validation (seilabs) - vale-spellcheck

STYLE_GUIDE.md#L267 

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

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

Expand Down
79 changes: 58 additions & 21 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,8 @@
"learn/dev-gas",
"learn/accounts",
"learn/sip-03-migration",
"learn/sip-03-exchange-migration"
"learn/sip-03-exchange-migration",
"cosmos-sdk/index"
]
},
{
Expand Down Expand Up @@ -221,23 +222,6 @@
{
"group": "Ecosystem Tutorials",
"pages": [
{
"group": "sei-js Examples",
"pages": [
"evm/evm-parity/examples/viem-quickstart",
"evm/evm-parity/examples/ethers-quickstart",
"evm/evm-parity/examples/wagmi-react",
"evm/evm-parity/examples/erc20",
"evm/evm-parity/examples/erc721",
"evm/evm-parity/examples/erc1155",
"evm/evm-parity/examples/multicall",
"evm/evm-parity/examples/pointer-contracts",
"evm/evm-parity/examples/sei-precompiles",
"evm/evm-parity/examples/deploy-verify",
"evm/evm-parity/examples/transaction-lifecycle",
"evm/evm-parity/examples/error-handling"
]
},
{
"group": "Indexers",
"pages": [
Expand Down Expand Up @@ -304,12 +288,55 @@
]
},
{
"tab": "Cosmos-SDK",
"tab": "Cookbook",
"groups": [
{
"group": "Cosmos-SDK",
"group": "Overview",
"pages": [
"cosmos-sdk/index"
"evm/cookbook/index"
]
},
{
"group": "Client Setup",
"pages": [
"evm/evm-parity/examples/viem-quickstart",
"evm/evm-parity/examples/ethers-quickstart",
"evm/evm-parity/examples/wagmi-react"
]
},
{
"group": "Accounts and Transactions",
"pages": [
"evm/cookbook/read-a-balance",
"evm/cookbook/send-sei",
"evm/evm-parity/examples/transaction-lifecycle",
"evm/evm-parity/examples/error-handling",
"evm/cookbook/sponsor-gas-with-pimlico"
]
},
{
"group": "Tokens",
"pages": [
"evm/cookbook/deploy-an-erc20",
"evm/evm-parity/examples/erc20",
"evm/evm-parity/examples/erc721",
"evm/evm-parity/examples/erc1155"
]
},
{
"group": "Contracts",
"pages": [
"evm/evm-parity/examples/deploy-verify",
"evm/cookbook/listen-to-events",
"evm/evm-parity/examples/multicall",
"evm/cookbook/read-a-price-feed"
]
},
{
"group": "Sei Features",
"pages": [
"evm/evm-parity/examples/sei-precompiles",
"evm/evm-parity/examples/pointer-contracts"
]
}
]
Expand Down Expand Up @@ -1697,6 +1724,16 @@
"source": "/templates",
"destination": "/evm/templates",
"permanent": true
},
{
"source": "/cookbook",
"destination": "/evm/cookbook",
"permanent": true
},
{
"source": "/evm/evm-parity/examples",
"destination": "/evm/cookbook",
"permanent": true
}
],
"interaction": {
Expand Down
Loading
Loading