Skip to content

fix: merge tutorials into guides #589

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.

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
merged 2 commits into from
Jul 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
42 changes: 14 additions & 28 deletions .vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -172,8 +172,7 @@ export default withMermaid({
function nav() {
return [
{ text: "Learn", link: "/learn/about" },
{ text: "Tutorials", link: "/tutorials/quick-start" },
{ text: "How To Guides", link: "/guides/overview" },
{ text: "How To Guides", link: "/guides/quick-start" },
{ text: "Blog", link: "/blog/overview" },
];
}
Expand Down Expand Up @@ -206,29 +205,29 @@ function sidebarHome() {
],
},
{
text: "Tutorials",
text: "How To Guides",
collapsed: true,
items: [
{
text: "Quick start guide",
link: "/tutorials/quick-start",
link: "/guides/quick-start",
},
{ text: "Build a chain", link: "/tutorials/gm-world" },
{ text: "Build a chain", link: "/guides/gm-world" },
{
text: "DA",
collapsed: true,
items: [
{
text: "Overview",
link: "/tutorials/da/overview",
link: "/guides/da/overview",
},
{
text: "Local DA",
link: "/tutorials/da/local-da",
link: "/guides/da/local-da",
},
{
text: "Celestia",
link: "/tutorials/da/celestia-da",
link: "/guides/da/celestia-da",
},
],
},
Expand All @@ -238,34 +237,27 @@ function sidebarHome() {
items: [
{
text: "Overview",
link: "/tutorials/sequencing/overview",
link: "/guides/sequencing/overview",
},
{
text: "Single",
link: "/tutorials/sequencing/single",
link: "/guides/sequencing/single",
},
{
text: "Based",
link: "/tutorials/sequencing/based",
link: "/guides/sequencing/based",
},
{
text: "Forced Inclusion",
link: "/tutorials/sequencing/forced-inclusion",
link: "/guides/sequencing/forced-inclusion",
},
],
},
{
text: "Execution",
collapsed: true,
items: [
{ text: "CosmWasm", link: "/tutorials/execution/cosmwasm" },
// {
// text: "EVM",
// collapsed: true,
// items: [
// // { text: "RETH EVM", link: "/tutorials/execution/reth-evm" },
// ],
// },
{ text: "CosmWasm", link: "/guides/execution/cosmwasm" },
],
},
{
Expand All @@ -274,20 +266,14 @@ function sidebarHome() {
items: [
{
text: "Overview",
link: "/tutorials/deploy-overview",
link: "/guides/deploy-overview",
},
{
text: "Docker Compose",
link: "/tutorials/docker-compose",
link: "/guides/docker-compose",
},
],
},
],
},
{
text: "How To Guides",
collapsed: true,
items: [
{
text: "Run a Full Node",
link: "/guides/full-node",
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Welcome to the official documentation repository for Rollkit.

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

## Building the site

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

## Directory Structure

* /tutorials: Step-by-step instructions to help users build their own rollups with Rollkit.
* /guides: Step-by-step instructions to help users build their own rollups with Rollkit.
* /learn: Technical reference materials, such as configuration options and details about the Rollkit stack.
* /blog: Blog posts for the Rollkit blog.
<!-- * /guides [WIP]: In-depth articles that cover specific topics in detail. -->
Expand Down
2 changes: 1 addition & 1 deletion blog/rollkit-the-first-sovereign-rollup-framework.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,5 +70,5 @@ Rollkit rollups pay only for data availability on demand. There is no sequencer

## Break Free. Be Sovereign.

[Get started](https://rollkit.dev/tutorials/quick-start) with launching your own sovereign chain with Rollkit.
[Get started](/guides/quick-start.md) with launching your own sovereign chain with Rollkit.
If you’re thinking of building a sovereign chain, we’d love to hear from you. Fill out this [form](https://forms.gle/yumLqipqr8weYmAb7).
4 changes: 2 additions & 2 deletions guides/create-genesis.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This guide will walk you through the process of setting up a genesis for your ro

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

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

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

## 2. Rebuild your chain

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:
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:

```sh
rollkit rebuild
Expand Down
4 changes: 2 additions & 2 deletions tutorials/da/celestia-da.md → guides/da/celestia-da.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import constants from '../../.vitepress/constants/constants.js'

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.

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.
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.

## 🪶 Running a Celestia light node

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

## 🏗️ Prerequisites {#prerequisites}

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

## 🛠️ Configuring flags for DA

Expand Down
2 changes: 1 addition & 1 deletion tutorials/da/local-da.md → guides/da/local-da.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import constants from '../../.vitepress/constants/constants.js'

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

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.
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.

## Setting Up a Local DA Network

Expand Down
6 changes: 3 additions & 3 deletions tutorials/da/overview.md → guides/da/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ type DA interface {

## Mock DA {#mock-da}

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.
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.

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

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

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.

* [Local DA](/tutorials/da/local-da.md)
* [Celestia DA](/tutorials/da/celestia-da.md)
* [Local DA](/guides/da/local-da.md)
* [Celestia DA](/guides/da/celestia-da.md)
3 changes: 1 addition & 2 deletions tutorials/deploy-overview.md → guides/deploy-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,4 @@ In this section, you'll see a few examples of how you can deploy your rollup env
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.
:::

* [Deploy with Docker Compose](/tutorials/docker-compose.md)
<!-- * [Deploy with Kurtosis](/tutorials/kurtosis) -->
* [Deploy with Docker Compose](/guides/docker-compose.md)
6 changes: 3 additions & 3 deletions tutorials/docker-compose.md → guides/docker-compose.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 🐳 Docker Compose

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

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

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

## 💻 Pre-requisites {#prerequisites}

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

## 🛠️ Dependencies {#dependencies}

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

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).
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).

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ this tutorial.

## 💻 CosmWasm dependency {#dependencies}

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).
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).

Once installed, you can verify the installation by running:

Expand Down
2 changes: 1 addition & 1 deletion tutorials/gm-world.md → guides/gm-world.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Learn how to build and deploy a CosmWasm-based "gm" (good morning)

## 🌞 Introduction {#introduction}

This tutorial will guide you through building a sovereign `gm-world` rollup (`gm` stands for "good morning") using Rollkit. Unlike the [quick start guide](https://rollkit.dev/tutorials/quick-start), this tutorial provides a more practical approach to understanding sovereign rollup development.
This tutorial will guide you through building a sovereign `gm-world` rollup (`gm` stands for "good morning") using Rollkit. Unlike the [quick start guide](/guides/quick-start.md), this tutorial provides a more practical approach to understanding sovereign rollup development.

We will cover:

Expand Down
File renamed without changes.
4 changes: 2 additions & 2 deletions guides/reset-state.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Some reason you might need to reset the state of your chain are:

## Prerequisites

In order to complete this guide, you will need to have completed either the [quick start tutorial](/tutorials/quick-start.md) or the [build our chain tutorial](/tutorials/gm-world.md).
In order to complete this guide, you will need to have completed either the [quick start tutorial](/guides/quick-start.md) or the [build our chain tutorial](/guides/gm-world.md).

## Quick Start

Expand Down Expand Up @@ -52,7 +52,7 @@ When you launch your chain again with `rollkit start` your `.rollkit` directory

## gm-world

When you ran your gm-world chain in the [build your chain tutorial](/tutorials/gm-world.md), it created a `.gm` directory in your `$HOME` directory.
When you ran your gm-world chain in the [build your chain tutorial](/guides/gm-world.md), it created a `.gm` directory in your `$HOME` directory.

This directory will look like the following:

Expand Down
4 changes: 2 additions & 2 deletions guides/restart-rollup.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This section covers the case where you need to restart your rollup.
In order to restart your rollup, you simply need to run the `<your-binary>d start [...args]`
command for your rollup.

For example, if you ran the [quick start](/tutorials/quick-start.md) tutorial, you started your rollup with:
For example, if you ran the [quick start](/guides/quick-start.md) tutorial, you started your rollup with:

```bash
rollkit start
Expand Down Expand Up @@ -48,7 +48,7 @@ you are using to post blocks to your DA and consensus layer runs out of funds (t
and you need to restart your rollup.

In this example, we're using Celestia's [Mocha testnet](https://docs.celestia.org/how-to-guides/mocha-testnet/)
and running the [quick start](/tutorials/quick-start.md). In this example, our Celestia DA light node
and running the [quick start](/guides/quick-start.md). In this example, our Celestia DA light node
ran out of Mocha testnet TIA and we are unable to post new blocks to Celestia due to a
[`Code: 19`](https://github.com/cosmos/cosmos-sdk/blob/main/types/errors/errors.go#L95)
error. This error is defined by Cosmos SDK as:
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,5 @@ An implementation of the sequencing interface mainly acts as a middleware that c

The sequencing implementations that are currently work in progress:
<!-- * [single-sequencer](single) -->
* [based-sequencer](/tutorials/sequencing/based.md)
* [forced-inclusion-sequencer](/tutorials/sequencing/forced-inclusion.md)
* [based-sequencer](/guides/sequencing/based.md)
* [forced-inclusion-sequencer](/guides/sequencing/forced-inclusion.md)
File renamed without changes.
2 changes: 1 addition & 1 deletion guides/use-tia-for-gas.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Build a sovereign rollup using Rollkit CLI and a local DA network,

## 🌞 Introduction {#introduction}

This tutorial will guide you through building a sovereign `gm-world` rollup using Rollkit, with TIA as the gas token. Unlike the [quick start guide](https://rollkit.dev/tutorials/quick-start), which uses a native rollup token for gas, this tutorial demonstrates how to integrate an IBC-enabled token, TIA, as the gas token within the rollup, providing a deeper exploration of sovereign rollup development.
This tutorial will guide you through building a sovereign `gm-world` rollup using Rollkit, with TIA as the gas token. Unlike the [quick start guide](/guides/quick-start.md), which uses a native rollup token for gas, this tutorial demonstrates how to integrate an IBC-enabled token, TIA, as the gas token within the rollup, providing a deeper exploration of sovereign rollup development.

We will cover:

Expand Down
2 changes: 1 addition & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ hero:
actions:
- theme: brand
text: Quick start
link: /tutorials/quick-start
link: /guides/quick-start
- theme: alt
text: Introduction
link: /learn/about
Expand Down
4 changes: 2 additions & 2 deletions learn/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Our mission is to allow anyone to launch their own sovereign, customizable block
::: tip
In order to use Rollkit, it's important to have some familiarity with Cosmos SDK. You can get up to speed on Cosmos SDK by visiting their [official documentation page](https://docs.cosmos.network/main).

If you're familiar with Rollkit, you may want to skip to the [tutorials section](/tutorials/gm-world.md).
If you're familiar with Rollkit, you may want to skip to the [guides section](/guides/gm-world.md).
:::

## What is Rollkit?
Expand Down Expand Up @@ -94,6 +94,6 @@ As of today, Rollkit is still in the alpha stage. The framework currently provid

We're currently working on implementing many new and exciting features such as light nodes and state fraud proofs.

Head down to the next section to learn more about what's coming for Rollkit. If you're ready to start building, you can skip to the [Tutorials](/tutorials/gm-world.md) section.
Head down to the next section to learn more about what's coming for Rollkit. If you're ready to start building, you can skip to the [Guides](/guides/gm-world.md) section.

Spoiler alert, whichever you choose, it's going to be a great rabbit hole!
File renamed without changes.