diff --git a/.vitepress/config.ts b/.vitepress/config.ts index 389a8c0c6..e8052b79b 100644 --- a/.vitepress/config.ts +++ b/.vitepress/config.ts @@ -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" }, ]; } @@ -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", }, ], }, @@ -238,19 +237,19 @@ 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", }, ], }, @@ -258,14 +257,7 @@ function sidebarHome() { 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" }, ], }, { @@ -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", diff --git a/README.md b/README.md index 1be8719c5..22955e597 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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. diff --git a/blog/rollkit-the-first-sovereign-rollup-framework.md b/blog/rollkit-the-first-sovereign-rollup-framework.md index 5db8f61c1..5131a84dc 100644 --- a/blog/rollkit-the-first-sovereign-rollup-framework.md +++ b/blog/rollkit-the-first-sovereign-rollup-framework.md @@ -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). diff --git a/guides/create-genesis.md b/guides/create-genesis.md index d7eb46ff9..32d1f9a59 100644 --- a/guides/create-genesis.md +++ b/guides/create-genesis.md @@ -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. @@ -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 diff --git a/tutorials/da/celestia-da.md b/guides/da/celestia-da.md similarity index 96% rename from tutorials/da/celestia-da.md rename to guides/da/celestia-da.md index 49624cf65..126e0a6a0 100644 --- a/tutorials/da/celestia-da.md +++ b/guides/da/celestia-da.md @@ -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 @@ -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 diff --git a/tutorials/da/local-da.md b/guides/da/local-da.md similarity index 91% rename from tutorials/da/local-da.md rename to guides/da/local-da.md index 48728aefa..db8fb913f 100644 --- a/tutorials/da/local-da.md +++ b/guides/da/local-da.md @@ -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 diff --git a/tutorials/da/overview.md b/guides/da/overview.md similarity index 93% rename from tutorials/da/overview.md rename to guides/da/overview.md index 9b69704cf..05566e6f8 100644 --- a/tutorials/da/overview.md +++ b/guides/da/overview.md @@ -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: @@ -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) diff --git a/tutorials/deploy-overview.md b/guides/deploy-overview.md similarity index 89% rename from tutorials/deploy-overview.md rename to guides/deploy-overview.md index 49be96a39..ea16c8a48 100644 --- a/tutorials/deploy-overview.md +++ b/guides/deploy-overview.md @@ -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 Docker Compose](/guides/docker-compose.md) diff --git a/tutorials/docker-compose.md b/guides/docker-compose.md similarity index 97% rename from tutorials/docker-compose.md rename to guides/docker-compose.md index 710a37044..a7d843e35 100644 --- a/tutorials/docker-compose.md +++ b/guides/docker-compose.md @@ -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/). @@ -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} @@ -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: diff --git a/tutorials/execution/cosmwasm.md b/guides/execution/cosmwasm.md similarity index 98% rename from tutorials/execution/cosmwasm.md rename to guides/execution/cosmwasm.md index 0528c035e..c99247637 100644 --- a/tutorials/execution/cosmwasm.md +++ b/guides/execution/cosmwasm.md @@ -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: diff --git a/tutorials/gm-world.md b/guides/gm-world.md similarity index 98% rename from tutorials/gm-world.md rename to guides/gm-world.md index 3a192ed02..b71ad1f71 100644 --- a/tutorials/gm-world.md +++ b/guides/gm-world.md @@ -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: diff --git a/tutorials/quick-start.md b/guides/quick-start.md similarity index 100% rename from tutorials/quick-start.md rename to guides/quick-start.md diff --git a/guides/reset-state.md b/guides/reset-state.md index 5bddd3794..9c57aefe9 100644 --- a/guides/reset-state.md +++ b/guides/reset-state.md @@ -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 @@ -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: diff --git a/guides/restart-rollup.md b/guides/restart-rollup.md index 04175ade9..501e33135 100644 --- a/guides/restart-rollup.md +++ b/guides/restart-rollup.md @@ -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 `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 @@ -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: diff --git a/tutorials/sequencing/based.md b/guides/sequencing/based.md similarity index 100% rename from tutorials/sequencing/based.md rename to guides/sequencing/based.md diff --git a/tutorials/sequencing/forced-inclusion.md b/guides/sequencing/forced-inclusion.md similarity index 100% rename from tutorials/sequencing/forced-inclusion.md rename to guides/sequencing/forced-inclusion.md diff --git a/tutorials/sequencing/overview.md b/guides/sequencing/overview.md similarity index 95% rename from tutorials/sequencing/overview.md rename to guides/sequencing/overview.md index 28501f1e7..c724aafbe 100644 --- a/tutorials/sequencing/overview.md +++ b/guides/sequencing/overview.md @@ -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: -* [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) diff --git a/tutorials/sequencing/single.md b/guides/sequencing/single.md similarity index 100% rename from tutorials/sequencing/single.md rename to guides/sequencing/single.md diff --git a/guides/use-tia-for-gas.md b/guides/use-tia-for-gas.md index a12b71e23..758a15f51 100644 --- a/guides/use-tia-for-gas.md +++ b/guides/use-tia-for-gas.md @@ -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: diff --git a/index.md b/index.md index bdd14c444..bafadae27 100644 --- a/index.md +++ b/index.md @@ -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 diff --git a/learn/about.md b/learn/about.md index 81794c492..973ddfb2a 100644 --- a/learn/about.md +++ b/learn/about.md @@ -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? @@ -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! diff --git a/guides/config.md b/learn/config.md similarity index 100% rename from guides/config.md rename to learn/config.md