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

Commit 28ff2d1

Browse files
committed
merge tutorials into guides
1 parent 5df44dc commit 28ff2d1

22 files changed

+40
-55
lines changed

.vitepress/config.ts

Lines changed: 13 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,6 @@ export default withMermaid({
172172
function nav() {
173173
return [
174174
{ text: "Learn", link: "/learn/about" },
175-
{ text: "Tutorials", link: "/tutorials/quick-start" },
176175
{ text: "How To Guides", link: "/guides/overview" },
177176
{ text: "Blog", link: "/blog/overview" },
178177
];
@@ -206,29 +205,29 @@ function sidebarHome() {
206205
],
207206
},
208207
{
209-
text: "Tutorials",
208+
text: "How To Guides",
210209
collapsed: true,
211210
items: [
212211
{
213212
text: "Quick start guide",
214-
link: "/tutorials/quick-start",
213+
link: "/guides/quick-start",
215214
},
216-
{ text: "Build a chain", link: "/tutorials/gm-world" },
215+
{ text: "Build a chain", link: "/guides/gm-world" },
217216
{
218217
text: "DA",
219218
collapsed: true,
220219
items: [
221220
{
222221
text: "Overview",
223-
link: "/tutorials/da/overview",
222+
link: "/guides/da/overview",
224223
},
225224
{
226225
text: "Local DA",
227-
link: "/tutorials/da/local-da",
226+
link: "/guides/da/local-da",
228227
},
229228
{
230229
text: "Celestia",
231-
link: "/tutorials/da/celestia-da",
230+
link: "/guides/da/celestia-da",
232231
},
233232
],
234233
},
@@ -238,34 +237,27 @@ function sidebarHome() {
238237
items: [
239238
{
240239
text: "Overview",
241-
link: "/tutorials/sequencing/overview",
240+
link: "/guides/sequencing/overview",
242241
},
243242
{
244243
text: "Single",
245-
link: "/tutorials/sequencing/single",
244+
link: "/guides/sequencing/single",
246245
},
247246
{
248247
text: "Based",
249-
link: "/tutorials/sequencing/based",
248+
link: "/guides/sequencing/based",
250249
},
251250
{
252251
text: "Forced Inclusion",
253-
link: "/tutorials/sequencing/forced-inclusion",
252+
link: "/guides/sequencing/forced-inclusion",
254253
},
255254
],
256255
},
257256
{
258257
text: "Execution",
259258
collapsed: true,
260259
items: [
261-
{ text: "CosmWasm", link: "/tutorials/execution/cosmwasm" },
262-
// {
263-
// text: "EVM",
264-
// collapsed: true,
265-
// items: [
266-
// // { text: "RETH EVM", link: "/tutorials/execution/reth-evm" },
267-
// ],
268-
// },
260+
{ text: "CosmWasm", link: "/guides/execution/cosmwasm" },
269261
],
270262
},
271263
{
@@ -274,20 +266,14 @@ function sidebarHome() {
274266
items: [
275267
{
276268
text: "Overview",
277-
link: "/tutorials/deploy-overview",
269+
link: "/guides/deploy-overview",
278270
},
279271
{
280272
text: "Docker Compose",
281-
link: "/tutorials/docker-compose",
273+
link: "/guides/docker-compose",
282274
},
283275
],
284276
},
285-
],
286-
},
287-
{
288-
text: "How To Guides",
289-
collapsed: true,
290-
items: [
291277
{
292278
text: "Run a Full Node",
293279
link: "/guides/full-node",

README.md

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

55
Welcome to the official documentation repository for Rollkit.
66

7-
Here you'll find comprehensive guides, tutorials, and reference materials to help you make the most out of Rollkit.
7+
Here you'll find comprehensive guides, and reference materials to help you make the most out of Rollkit.
88

99
## Building the site
1010

@@ -29,7 +29,7 @@ Please ensure you review the detailed Contribution Guidelines above before makin
2929

3030
## Directory Structure
3131

32-
* /tutorials: Step-by-step instructions to help users build their own rollups with Rollkit.
32+
* /guides: Step-by-step instructions to help users build their own rollups with Rollkit.
3333
* /learn: Technical reference materials, such as configuration options and details about the Rollkit stack.
3434
* /blog: Blog posts for the Rollkit blog.
3535
<!-- * /guides [WIP]: In-depth articles that cover specific topics in detail. -->

blog/rollkit-the-first-sovereign-rollup-framework.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,5 +70,5 @@ Rollkit rollups pay only for data availability on demand. There is no sequencer
7070

7171
## Break Free. Be Sovereign.
7272

73-
[Get started](https://rollkit.dev/tutorials/quick-start) with launching your own sovereign chain with Rollkit.
73+
[Get started](/guides/quick-start.md) with launching your own sovereign chain with Rollkit.
7474
If you’re thinking of building a sovereign chain, we’d love to hear from you. Fill out this [form](https://forms.gle/yumLqipqr8weYmAb7).

guides/create-genesis.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This guide will walk you through the process of setting up a genesis for your ro
66

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

9-
If you don't have a chain directory yet, you can initialize a simple ignite chain by following [this tutorial](/tutorials/gm-world.md)
9+
If you don't have a chain directory yet, you can initialize a simple ignite chain by following [this tutorial](/guides/gm-world.md)
1010

1111
:::tip
1212
This guide will use the simple ignite chain created in linked guide. Make sure to update any relevant variables to match your chain.
@@ -27,7 +27,7 @@ STAKING_AMOUNT="1000000000stake"
2727

2828
## 2. Rebuild your chain
2929

30-
Ensure that `rollkit.toml` is present in the root of your rollup directory (if not, follow a [Guide](/tutorials/gm-world.md) to set it up) and run the following command to (re)generate an entrypoint binary out of the code:
30+
Ensure that `rollkit.toml` is present in the root of your rollup directory (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

3232
```sh
3333
rollkit rebuild
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import constants from '../../.vitepress/constants/constants.js'
99

1010
This tutorial serves as a comprehensive guide for deploying your rollup on Celestia's data availability (DA) network. From the Rollkit perspective, there's no difference in posting blocks to Celestia's testnets or Mainnet Beta.
1111

12-
Before proceeding, ensure that you have completed the [gm-world](/tutorials/gm-world.md) tutorial, which covers installing the Testapp CLI and running a rollup against a local DA network.
12+
Before proceeding, ensure that you have completed the [gm-world](/guides/gm-world.md) tutorial, which covers installing the Testapp CLI and running a rollup against a local DA network.
1313

1414
## 🪶 Running a Celestia light node
1515

@@ -46,7 +46,7 @@ After successfully starting a light node, it's time to start posting the batches
4646

4747
## 🏗️ Prerequisites {#prerequisites}
4848

49-
- `gmd` CLI installed from the [gm-world](/tutorials/gm-world.md) tutorial.
49+
- `gmd` CLI installed from the [gm-world](/guides/gm-world.md) tutorial.
5050

5151
## 🛠️ Configuring flags for DA
5252

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import constants from '../../.vitepress/constants/constants.js'
99

1010
This tutorial serves as a comprehensive guide for using the [local-da](https://github.com/rollkit/local-da) with your chain.
1111

12-
Before proceeding, ensure that you have completed the [quick start](/tutorials/quick-start.md) or [build a chain](/tutorials/gm-world.md) tutorial, which covers installing the rollkit CLI, building your chain, and running your chain.
12+
Before proceeding, ensure that you have completed the [quick start](/guides/quick-start.md) or [build a chain](/guides/gm-world.md) tutorial, which covers installing the rollkit CLI, building your chain, and running your chain.
1313

1414
## Setting Up a Local DA Network
1515

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ type DA interface {
5858

5959
## Mock DA {#mock-da}
6060

61-
You might have noticed that we did not define any DA layer during the [quick start](/tutorials/quick-start.md) or [build a chain](/tutorials/gm-world.md) tutorials. This is because we used a mock DA layer that is built into Rollkit.
61+
You might have noticed that we did not define any DA layer during the [quick start](/guides/quick-start.md) or [build a chain](/guides/gm-world.md) tutorials. This is because we used a mock DA layer that is built into Rollkit.
6262

6363
If you revisit the logs from those tutorials, you will see one of the first lines being:
6464

@@ -72,5 +72,5 @@ The mock DA layer is a simple in-memory DA layer that is great for testing and d
7272

7373
Now that you have a better understanding of what a DA layer is, you can start to explore the different DA layers that are available to use with Rollkit.
7474

75-
* [Local DA](/tutorials/da/local-da.md)
76-
* [Celestia DA](/tutorials/da/celestia-da.md)
75+
* [Local DA](/guides/da/local-da.md)
76+
* [Celestia DA](/guides/da/celestia-da.md)
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,4 @@ In this section, you'll see a few examples of how you can deploy your rollup env
1616
These examples are for educational purposes only. Before deploying your rollup for production use you should fully understand the services you are deploying and your choice in deployment method.
1717
:::
1818

19-
* [Deploy with Docker Compose](/tutorials/docker-compose.md)
20-
<!-- * [Deploy with Kurtosis](/tutorials/kurtosis) -->
19+
* [Deploy with Docker Compose](/guides/docker-compose.md)
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 🐳 Docker Compose
22

3-
This tutorial is going to show you how to deploy the [gm-world chain](/tutorials/gm-world.md) using Docker Compose.
3+
This tutorial is going to show you how to deploy the [gm-world chain](/guides/gm-world.md) using Docker Compose.
44

55
You can learn more about Docker Compose [here](https://docs.docker.com/compose/).
66

@@ -17,7 +17,7 @@ import constants from '../.vitepress/constants/constants.js'
1717

1818
## 💻 Pre-requisites {#prerequisites}
1919

20-
Make sure you have your gm-world chain ready by completing [the Build your chain tutorial](/tutorials/gm-world.md).
20+
Make sure you have your gm-world chain ready by completing [the Build your chain tutorial](/guides/gm-world.md).
2121

2222
## 🛠️ Dependencies {#dependencies}
2323

@@ -216,7 +216,7 @@ Since our chain is running in a docker container, we want to enter the docker co
216216
docker exec -it gm-world sh
217217
```
218218

219-
Now that you are in the docker container, you can interact with the chain using the Rollkit CLI and the example commands you used in the [gm-world tutorial](/tutorials/gm-world.md).
219+
Now that you are in the docker container, you can interact with the chain using the Rollkit CLI and the example commands you used in the [gm-world tutorial](/guides/gm-world.md).
220220

221221
Once you are done interacting with your chain, you can exit out of your docker container with:
222222

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ this tutorial.
2828

2929
## 💻 CosmWasm dependency {#dependencies}
3030

31-
As with the [GM Rollup](/tutorials/gm-world.md), we use [kurtosis](https://docs.kurtosis.com/) to help with managing all the services we need to run. You can [install kurtosis here](https://docs.kurtosis.com/install).
31+
As with the [GM Rollup](/guides/gm-world.md), we use [kurtosis](https://docs.kurtosis.com/) to help with managing all the services we need to run. You can [install kurtosis here](https://docs.kurtosis.com/install).
3232

3333
Once installed, you can verify the installation by running:
3434

0 commit comments

Comments
 (0)