Skip to content
This repository was archived by the owner on Aug 7, 2025. It is now read-only.

Commit 2934b89

Browse files
chore: small adjustments to the docs (#601)
* remove number from titles * move warning to top of the page * add make testlink command * move chapters to correct position * Update guides/cometbft-to-rollkit.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
1 parent 7095042 commit 2934b89

File tree

4 files changed

+23
-16
lines changed

4 files changed

+23
-16
lines changed

.vitepress/config.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -187,8 +187,6 @@ function sidebarHome() {
187187
text: "About Rollkit",
188188
link: "/learn/about",
189189
},
190-
{ text: "Transaction flow", link: "/learn/transaction-flow" },
191-
{ text: "Configuration", link: "/learn/config" },
192190
{
193191
text: "Data Availability",
194192
link: "/learn/data-availability",
@@ -219,6 +217,8 @@ function sidebarHome() {
219217
{ text: "Store", link: "/learn/specs/store" },
220218
],
221219
},
220+
{ text: "Transaction flow", link: "/learn/transaction-flow" },
221+
{ text: "Configuration", link: "/learn/config" },
222222
],
223223
},
224224
{

Makefile

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Makefile for docs
2+
3+
.PHONY: testlink
4+
5+
testlink:
6+
lychee -b . --verbose --exclude '%23.*' './**/*.md'

guides/cometbft-to-rollkit.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@ import constants from '../.vitepress/constants/constants.js'
1010

1111
This guide assumes you have a CometBFT app set up and [Ignite CLI](https://docs.ignite.com) installed.
1212

13+
:::warning
14+
This tutorial is currently being updated to reflect the latest changes using the rollkit ignite app.
15+
Please check back later for the updated version.
16+
:::
17+
1318
## Install Rollkit {#install-rollkit}
1419

1520
You need to install Rollkit in your CometBFT app. Open a terminal in the directory where your app is located and run the following command:
@@ -36,10 +41,6 @@ Run the following command to initialize Rollkit:
3641
ignite rollkit init
3742
```
3843

39-
:::warning
40-
This tutorial is being currently update to reflect the latest changes using the rollkit ignite app.
41-
Please check back later for the updated version.
42-
:::
4344

4445
<!-- TODO: update
4546

guides/create-genesis.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This guide will walk you through the process of setting up a genesis for your chain. Follow the steps below to initialize your chain, add a genesis account, and start the chain.
44

5-
## 0. Pre-requisities
5+
## Pre-requisities
66

77
For this guide you need to have a chain directory where you have created and built your chain.
88

@@ -25,7 +25,7 @@ TOKEN_AMOUNT="10000000000000000000000000stake"
2525
STAKING_AMOUNT="1000000000stake"
2626
```
2727

28-
## 2. Rebuild your chain
28+
## Rebuild your chain
2929

3030
Ensure that `.gm` folder is present at `/Users/you/.gm` (if not, follow a [Guide](/guides/gm-world.md) to set it up) and run the following command to (re)generate an entrypoint binary out of the code:
3131

@@ -41,7 +41,7 @@ ignite rollkit init
4141

4242
This (re)creates an `gmd` binary that will be used for the rest of the tutorials to run all the operations on the chain.
4343

44-
## 3. Resetting existing genesis/chain data
44+
## Resetting existing genesis/chain data
4545

4646
Reset any existing chain data:
4747

@@ -56,47 +56,47 @@ rm -rf $HOME/.$CHAIN_ID/config/gentx
5656
rm $HOME/.$CHAIN_ID/config/genesis.json
5757
```
5858

59-
## 4. Initializing the validator
59+
## Initializing the validator
6060

6161
Initialize the validator with the chain ID you set:
6262

6363
```sh
6464
gmd init $VALIDATOR_NAME --chain-id $CHAIN_ID
6565
```
6666

67-
## 5. Adding a key to keyring backend
67+
## Adding a key to keyring backend
6868

6969
Add a key to the keyring-backend:
7070

7171
```sh
7272
gmd keys add $KEY_NAME --keyring-backend test
7373
```
7474

75-
## 6. Adding a genesis account
75+
## Adding a genesis account
7676

7777
Add a genesis account with the specified token amount:
7878

7979
```sh
8080
gmd genesis add-genesis-account $KEY_NAME $TOKEN_AMOUNT --keyring-backend test
8181
```
8282

83-
## 7. Setting the staking amount in the genesis transaction
83+
## Setting the staking amount in the genesis transaction
8484

8585
Set the staking amount in the genesis transaction:
8686

8787
```sh
8888
gmd genesis gentx $KEY_NAME $STAKING_AMOUNT --chain-id $CHAIN_ID --keyring-backend test
8989
```
9090

91-
## 8. Collecting genesis transactions
91+
## Collecting genesis transactions
9292

9393
Collect the genesis transactions:
9494

9595
```sh
9696
gmd genesis collect-gentxs
9797
```
9898

99-
## 9. Configuring the genesis file
99+
## Configuring the genesis file
100100

101101
Copy the centralized sequencer address into `genesis.json`:
102102

@@ -106,7 +106,7 @@ PUB_KEY=$(jq -r '.pub_key' ~/.$CHAIN_ID/config/priv_validator_key.json)
106106
jq --argjson pubKey "$PUB_KEY" '.consensus["validators"]=[{"address": "'$ADDRESS'", "pub_key": $pubKey, "power": "1000", "name": "Rollkit Sequencer"}]' ~/.$CHAIN_ID/config/genesis.json > temp.json && mv temp.json ~/.$CHAIN_ID/config/genesis.json
107107
```
108108

109-
## 10. Starting the chain
109+
## Starting the chain
110110

111111
Finally, start the chain with your start command.
112112

0 commit comments

Comments
 (0)