Skip to content

Commit c9e8689

Browse files
authored
docs: update docs (#2691)
<!-- Please read and fill out this form before submitting your PR. Please make sure you have reviewed our contributors guide before submitting your first PR. NOTE: PR titles should follow semantic commits: https://www.conventionalcommits.org/en/v1.0.0/ --> ## Overview <!-- Please provide an explanation of the PR, including the appropriate context, background, goal, and rationale. If there is an issue with this information, please provide a tl;dr and link the issue. Ex: Closes #<issue number> -->
1 parent c59b807 commit c9e8689

File tree

15 files changed

+315
-307
lines changed

15 files changed

+315
-307
lines changed

docs/.vitepress/constants/constants.js

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
const constants = Object.freeze({
22
golangVersion: "go1.24.0",
33

4-
evolveLatestTag: "v1.0.0-beta.2",
5-
evolveLatestSha: "cd1970de",
6-
evolveIgniteAppVersion: "rollkit/v0.3.0",
4+
evolveLatestTag: "v1.0.0-beta.4",
5+
evolveIgniteAppVersion: "evolve/v0.4.0",
76

87
localDALatestTag: "v1.0.0-beta.1",
98
igniteVersionTag: "v28.5.3",

docs/guides/cometbft-to-evolve.md

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -41,32 +41,16 @@ Run the following command to initialize Evolve:
4141
ignite evolve init
4242
```
4343

44-
<!-- TODO: update
45-
46-
## Initialize Evolve CLI Configuration {#initialize-evolve-cli-configuration}
47-
48-
Next, you'll need to initialize the Evolve CLI configuration by generating the `evolve.toml` file. This file is crucial for Evolve to understand the structure of your chain.
49-
50-
To create the `evolve.toml` configuration, use this command:
51-
52-
```bash
53-
evolve toml init
54-
```
55-
56-
This command sets up the `evolve.toml` file, where you can further customize configuration parameters as needed.
57-
5844
## Start Your Evolve App {#start-evolve-app}
5945

6046
Once everything is configured, you can start your Evolve-enabled CometBFT app or (simply evolve app). Use the following command to start your blockchain:
6147

6248
```bash
63-
evolve start --evolve.aggregator <insert your flags>
49+
<yourappd> start --evnode.aggregator <insert your flags>
6450
```
6551

6652
## Summary
6753

6854
By following this guide, you've successfully converted your CometBFT app into an Evolve app.
6955

7056
To learn more about how to config your DA, Sequencing, and Execution, please check out those tutorial sections.
71-
72-
-->

docs/guides/da/local-da.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,8 @@ Before proceeding, ensure that you have completed the [build a chain](./gm-world
1515

1616
To set up a local DA network node on your machine, run the following script to install and start the local DA node:
1717

18-
```bash
19-
git clone --depth=1 --branch v1.0.0-beta.2 https://github.com/evstack/ev-node.git
20-
cd ev-node
21-
make build-da
22-
./build/local-da
18+
```bash-vue
19+
go install github.com/evstack/ev-node/da/cmd/local-da@latest
2320
```
2421

2522
This script will build and run the node, which will then listen on port `7980`.
@@ -39,7 +36,7 @@ testapp start --evnode.da.address http://localhost:7980
3936
```
4037

4138
```sh [gm-world Chain]
42-
gmd start \
39+
testapp start \
4340
--evnode.node.aggregator \
4441
--evnode.da.address http://localhost:7980 \
4542
```

docs/guides/deploy-overview.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,3 @@ In this section, you'll see a few examples of how you can deploy your chain envi
1515
:::warning Disclaimer
1616
These examples are for educational purposes only. Before deploying your chain for production use you should fully understand the services you are deploying and your choice in deployment method.
1717
:::
18-
19-
* [Deploy with Docker Compose](/docs/guides/deploy/local.md)

docs/guides/deploy/local.md

Lines changed: 0 additions & 237 deletions
This file was deleted.

docs/guides/deploy/overview.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ When you're ready to test with real network conditions, you can deploy to testne
3838

3939
Choose the deployment approach that matches your current needs:
4040

41-
- [🏠 Local Development with Docker Compose](./local.md) - Deploy locally for development and testing
4241
- [🌐 Testnet Deployment](./testnet.md) - Deploy on testnet with external DA networks
4342

4443
:::warning Disclaimer

docs/guides/deploy/testnet.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ import constants from '../../.vitepress/constants/constants.js'
1313
:::tip
1414
<Callout />
1515
:::
16+
1617
<!-- markdownlint-enable MD033 -->
1718

1819
## 🏗️ Architecture Overview
@@ -303,5 +304,3 @@ For detailed setup instructions, see:
303304
- [Single Sequencer Setup Guide](../evm/single.md) - Step-by-step deployment instructions
304305
- [RETH Backup Guide](../evm/reth-backup.md) - Data protection and backup procedures
305306
- [Celestia DA Guide](../da/celestia-da.md) - Connecting to Celestia networks
306-
307-
You can also learn more about local deployments in our [Docker Compose guide](../deploy/local.md).

docs/guides/evm/single.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,10 @@ This will start a local DA node on the default port (26658).
4747

4848
## Setting Up the EVM Layer
4949

50-
### 1. Clone the ev-node Repository
50+
### 1. Clone the ev-reth Repository
5151

5252
```bash
53-
git clone https://github.com/evstack/ev-node.git
53+
git clone --depth 1 https://github.com/evstack/ev-reth.git
5454
cd ev-node
5555
```
5656

@@ -140,21 +140,21 @@ INF block marked as DA included blockHash=XXXX blockHeight=XX module=BlockManage
140140

141141
### Common Flags
142142

143-
| Flag | Description |
144-
|------|-------------|
145-
| `--evnode.node.aggregator` | Set to true for sequencer mode, false for full node |
146-
| `--evnode.signer.passphrase` | Passphrase for the signer |
147-
| `--evnode.node.block_time` | Block time for the Evolve node |
143+
| Flag | Description |
144+
| ---------------------------- | --------------------------------------------------- |
145+
| `--evnode.node.aggregator` | Set to true for sequencer mode, false for full node |
146+
| `--evnode.signer.passphrase` | Passphrase for the signer |
147+
| `--evnode.node.block_time` | Block time for the Evolve node |
148148

149149
### EVM Flags
150150

151-
| Flag | Description |
152-
|------|-------------|
153-
| `--evm.eth-url` | Ethereum JSON-RPC URL (default `http://localhost:8545`) |
154-
| `--evm.engine-url` | Engine API URL (default `http://localhost:8551`) |
155-
| `--evm.jwt-secret` | JWT secret file path for the Engine API |
156-
| `--evm.genesis-hash` | Genesis block hash of the chain |
157-
| `--evm.fee-recipient` | Address to receive priority fees |
151+
| Flag | Description |
152+
| --------------------- | ------------------------------------------------------- |
153+
| `--evm.eth-url` | Ethereum JSON-RPC URL (default `http://localhost:8545`) |
154+
| `--evm.engine-url` | Engine API URL (default `http://localhost:8551`) |
155+
| `--evm.jwt-secret` | JWT secret file path for the Engine API |
156+
| `--evm.genesis-hash` | Genesis block hash of the chain |
157+
| `--evm.fee-recipient` | Address to receive priority fees |
158158

159159
## Conclusion
160160

0 commit comments

Comments
 (0)