feat: docs reorg (#350)

* chore: rename networks to testnets * chore: move guides into separate section * chore: reorg tutorials * chore: fix minor missed text updates * docs: remove home from top level nav * docs: fix restart-rollup backlinks * docs: fix other links --------- Co-authored-by: jcstein <[email protected]>
rollkit · Apr 23, 2024 · 2c86a1c · 2c86a1c
1 parent 7c3b9b5
commit 2c86a1c
Show file tree

Hide file tree

Showing 23 changed files with 102 additions and 82 deletions.
diff --git a/.vitepress/config.ts b/.vitepress/config.ts
@@ -167,11 +167,11 @@ export default withMermaid({
 
 function nav() {
   return [
-    { text: "Home", link: "/" },
     { text: "Intro", link: "/learn/intro" },
     { text: "Learn", link: "/learn/overview" },
     { text: "Tutorials", link: "/tutorials/overview" },
-    { text: "Networks", link: "/networks/cosmwasm-testnet" },
+    { text: "How To Guides", link: "/guides/overview" },
+    { text: "Testnets", link: "/testnets/cosmwasm-testnet" },
     { text: "Blog", link: "/blog/overview" },
   ];
 }
@@ -210,7 +210,7 @@ function sidebarHome() {
       items: [
         { text: "Overview", link: "/tutorials/overview" },
         {
-          text: "Beginner",
+          text: "Rollkit",
           collapsed: true,
           items: [
             // { text: 'Starter Rollup with Docker', link: '/tutorials/rollup-docker'},
@@ -219,81 +219,81 @@ function sidebarHome() {
               text: "GM world rollup: Part 1, local devnet",
               link: "/tutorials/gm-world",
             },
+            { text: "GM world frontend", link: "/tutorials/gm-world-frontend" },
+            { text: "Wordle app", link: "/tutorials/wordle" },
+          ],
+        },
+        {
+          text: "DA",
+          collapsed: true,
+          items: [
             {
-              text: "GM world rollup: Part 2, arabica devnet",
-              link: "/tutorials/gm-world-arabica-testnet",
-            },
-            {
-              text: "GM world rollup: Part 3, mocha testnet",
+              text: "GM world rollup: Part 2, mocha testnet",
               link: "/tutorials/gm-world-mocha-testnet",
             },
             {
-              text: "GM world rollup: Part 4, mainnet",
+              text: "GM world rollup: Part 3, mainnet",
               link: "/tutorials/gm-world-mainnet",
             },
-            { text: "GM world frontend", link: "/tutorials/gm-world-frontend" },
-            { text: "Recipe Book rollup", link: "/tutorials/recipe-book" },
-            {
-              text: "How to restart your rollup",
-              link: "/tutorials/restart-rollup",
-            },
           ],
         },
         {
-          text: "Intermediate",
+          text: "Execution",
           collapsed: true,
           items: [
-            { text: "Wordle app", link: "/tutorials/wordle" },
             { text: "CosmWasm rollup", link: "/tutorials/cosmwasm" },
             { text: "Polaris EVM rollup", link: "/tutorials/polaris-evm" },
-            { text: "zkML rollup", link: "/tutorials/zkml" },
-            { text: "IBC connection", link: "/tutorials/ibc-connection" },
+            // {
+            //   text: "Full-stack modular dapp with Celestia",
+            //   link: "https://docs.celestia.org/developers/full-stack-modular-development-guide",
+            // },
           ],
         },
+      ],
+    },
+    {
+      text: "How To Guides",
+      collapsed: true,
+      items: [
         {
-          text: "Advanced",
-          collapsed: true,
           items: [
             {
-              text: "Full and sequencer node rollup setup",
-              link: "/tutorials/full-and-sequencer-node",
+              text: "How to restart your rollup",
+              link: "/guides/restart-rollup",
             },
             {
-              text: "Full-stack modular dapp with Celestia",
-              link: "https://docs.celestia.org/developers/full-stack-modular-development-guide",
+              text: "How to run as a full and sequencer node",
+              link: "/guides/full-and-sequencer-node",
             },
-          ],
-        },
-        {
-          text: "Guides",
-          collapsed: true,
-          items: [
             {
               text: "How to configure gas price",
-              link: "/tutorials/gas-price",
+              link: "/guides/gas-price",
             },
             {
               text: "How to change speed of block production",
-              link: "/tutorials/block-times",
+              link: "/guides/block-times",
             },
             {
               text: "How to use lazy sequencing (aggregation)",
-              link: "/tutorials/lazy-sequencing",
+              link: "/guides/lazy-sequencing",
             },
             {
-              text: "Testing and deploying smart-contracts",
-              link: "/tutorials/cw-orch",
+              text: "How to test and deploy smart-contracts",
+              link: "/guides/cw-orch",
+            },
+            { text: "How to add zkML to your rollup", link: "/guides/zkml" },
+            {
+              text: "How to add an IBC connection to your rollup",
+              link: "/guides/ibc-connection",
             },
           ],
         },
       ],
     },
     {
-      text: "Networks",
+      text: "Testnets",
       collapsed: true,
-      items: [
-        { text: "Cosmwasm Testnet", link: "/networks/cosmwasm-testnet" },
-      ],
+      items: [{ text: "Cosmwasm Testnet", link: "/testnets/cosmwasm-testnet" }],
     },
     {
       text: "Blog",

diff --git a/tutorials/block-times.md → guides/block-times.md b/tutorials/block-times.md → guides/block-times.md
diff --git a/tutorials/cw-orch.md → guides/cw-orch.md b/tutorials/cw-orch.md → guides/cw-orch.md
@@ -22,6 +22,7 @@ In this quick-start guide, we will review the necessary steps in order to integr
 >If you're moving quicker than everybody else, we suggest looking at <a href="https://github.com/AbstractSDK/cw-orch-counter-example/compare/e0a54b074ca1a894bb6e58276944cf2013d152f2..main" target="_blank">a before-after review of this example integration</a>. This will help you catch the additions you need to make to your contract to be able to interact with it using cw-orchestrator.
 
 > **NOTE**: If you want to go more in depth, [browse the full `cw-orch` documentation](https://orchestrator.abstract.money/).
+
 ## Summary
 
 - [Speed up your development with cw-orchestrator](#speed-up-your-development-with-cw-orchestrator)
@@ -100,6 +101,7 @@ Learn more about the content of the interface creation specifics in the [`cw-orc
 >    #[cfg(not(target_arch = "wasm32"))]
 >    pub use crate::interface::CounterContract;
 >    ```
+
 ### Interaction helpers
 
 cw-orchestrator provides a additional macros that simplify contract calls and queries. The macro implements functions on the interface for each variant of the contract's `ExecuteMsg` and `QueryMsg`.

diff --git a/tutorials/full-and-sequencer-node.md → guides/full-and-sequencer-node.md b/tutorials/full-and-sequencer-node.md → guides/full-and-sequencer-node.md
diff --git a/tutorials/gas-price.md → guides/gas-price.md b/tutorials/gas-price.md → guides/gas-price.md
diff --git a/tutorials/ibc-connection.md → guides/ibc-connection.md b/tutorials/ibc-connection.md → guides/ibc-connection.md
diff --git a/tutorials/lazy-sequencing.md → guides/lazy-sequencing.md b/tutorials/lazy-sequencing.md → guides/lazy-sequencing.md
diff --git a/guides/overview.md b/guides/overview.md
@@ -0,0 +1,31 @@
+---
+description: This page provides a comprehensive overview of the how to guides available for Rollkit.
+---
+
+# How To Guides
+
+Welcome to the Rollkit guides section! Here, you'll find a wide range of guides
+designed to help you understand and effectively use Rollkit, the first sovereign
+rollup framework.
+
+Hopefully you've gone through some of the tutorials and are ready to dive
+deeper. These guides will go into detail on some specific topics that will make
+your life easier when developing with Rollkit.
+
+In this section, you'll find:
+
+  * [How to restart your rollup](/guides/restart-rollup.md)
+  * [zkML rollup](/guides/zkml.md)
+  * [IBC connection](/guides/ibc-connection.md)
+  * [Full and sequencer node rollup setup](/guides/full-and-sequencer-node.md)
+  * [How to configure gas price](/guides/gas-price.md)
+  * [How to change speed of block production](/guides/block-times.md)
+  * [How to use lazy sequencing (aggregation)](/guides/lazy-sequencing.md)
+  * [Testing and deploying smart-contract with cw-orch](/guides/cw-orch.md)
+
+## 💻 Support {#support}
+
+The guides will explore developing with Rollkit, which is still in Alpha stage.
+If you run into bugs, please write a Github
+[issue](https://github.com/rollkit/docs/issues/new) or let us know in our
+[Telegram](https://t.me/rollkit).
diff --git a/tutorials/restart-rollup.md → guides/restart-rollup.md b/tutorials/restart-rollup.md → guides/restart-rollup.md
diff --git a/tutorials/zkml.md → guides/zkml.md b/tutorials/zkml.md → guides/zkml.md
diff --git a/learn/building-and-deploying-a-rollup.md b/learn/building-and-deploying-a-rollup.md
@@ -13,7 +13,7 @@ You can get started with the following tutorials:
 - [GM world](/tutorials/gm-world)
 - [GM world frontend](/tutorials/gm-world-frontend)
 - [Recipe Book](/tutorials/recipe-book)
-- [Restart your rollup](/tutorials/restart-rollup)
+- [Restart your rollup](/guides/restart-rollup)
 
 ## 2️. Intermediate {#intermediate}
 

diff --git a/learn/intro.md b/learn/intro.md
@@ -39,9 +39,9 @@ If you're familiar with Rollkit, you may want to skip to the [tutorials section]
 
 [Overview](/tutorials/overview)
 
-### Networks
+### Testnets
 
-- [Cosmwasm Testnet](/networks/cosmwasm-testnet)
+- [Cosmwasm Testnet](/testnets/cosmwasm-testnet)
 
 ### Blog
 

diff --git a/networks/cosmwasm-testnet.md → testnets/cosmwasm-testnet.md b/networks/cosmwasm-testnet.md → testnets/cosmwasm-testnet.md
@@ -104,7 +104,7 @@ wasmd query txs --query "message.sender='wasm1lysztpn74kl40w6ghfhy7xr0v44r658szu
 :::
 - Faucet: [https://faucet.rosm.rollkit.dev/](https://faucet.rosm.rollkit.dev/)
     - You can request 1 rosm (or 1000000urosm) every 24 hours.  
-![Faucet](/networks/faucet.png)
+![Faucet](/testnets/faucet.png)
 - Mocha Namespace: `000000000000000000000000000000000000b7b24d9321578eb83626`, view it on Celenium [here](https://mocha.celenium.io/namespace/000000000000000000000000000000000000b7b24d9321578eb83626)
 - DA Block Time: `15s`
 - Rollup Block Time: `10s`

diff --git a/networks/faucet.png → testnets/faucet.png b/networks/faucet.png → testnets/faucet.png
diff --git a/tutorials/cosmwasm.md b/tutorials/cosmwasm.md
@@ -13,7 +13,7 @@ which is still in Alpha stage. If you run into bugs, please write a Github
 [Issue ticket](https://github.com/rollkit/docs/issues/new)
 or let us know in our [Telegram](https://t.me/rollkit).
 
-Learn how to [restart your rollup](restart-rollup.md).
+Learn how to [restart your rollup](/guides/restart-rollup.md).
 :::
 
 ::: warning
@@ -275,7 +275,7 @@ Let's now deploy our smart contract!
 
 In order to deploy a contract, you can use the command line as described below.
 For a better experience and to use Rust code instead of the command line to
-deploy/script and test your contracts, you can use [cw-orchestrator](./cw-orch.md). 
+deploy/script and test your contracts, you can use [cw-orchestrator](/guides/cw-orch.md). 
 
 Run the following in the `~/cw-contracts/contracts/nameservice` directory:
 
@@ -311,7 +311,7 @@ In the previous steps, we have stored out contract's tx hash in an
 environment variable for later use.
 
 The following guide will show you how to deploy and interact with a contract using CLI. 
-For scripting using Rust, you can use [cw-orchestrator](./cw-orch.md).
+For scripting using Rust, you can use [cw-orchestrator](/guides/cw-orch.md).
 
 Because of the longer time periods of submitting transactions via Rollkit
 due to waiting on Celestia's data availability layer to confirm block inclusion,

diff --git a/tutorials/gm-world-arabica-testnet.md b/tutorials/gm-world-arabica-testnet.md
@@ -250,4 +250,4 @@ In the next tutorial, you'll learn how to post data to Celestia's
 Mainnet Beta.
 
 If you're interested in setting up a full node alongside your sequencer,
-see the [Full and sequencer node rollup setup](./full-and-sequencer-node) tutorial.
+see the [Full and sequencer node rollup setup](/guides/full-and-sequencer-node) tutorial.
diff --git a/tutorials/gm-world-mainnet.md b/tutorials/gm-world-mainnet.md
@@ -1,10 +1,9 @@
-# GM world rollup: Part 4
+# GM world rollup: Part 3
 
-This tutorial is part 4 of the GM world rollup tutorials. In this tutorial,
-it is expected that you've completed [part 1](./gm-world.md), [part 2](./gm-world-arabica-testnet.md) or
-[part 3](./gm-world-mocha-testnet.md) of the tutorial and are
-familiar with running a local rollup devnet and posting to a
-Celestia testnet.
+This tutorial is part 3 of the GM world rollup tutorials. In this tutorial, it
+is expected that you've completed [part 1](./gm-world.md) or [part
+2](./gm-world-mocha-testnet.md) of the tutorial and are familiar with running a
+local rollup devnet or posting to a Celestia testnet.
 
 ## Deploying to Celestia Mainnet Beta
 
@@ -87,4 +86,4 @@ Congratulations! You have a Rollkit rollup running on Celestia's
 Mainnet Beta.
 
 If you're interested in setting up a full node alongside your sequencer,
-see the [Full and sequencer node rollup setup](./full-and-sequencer-node) tutorial.
+see the [Full and sequencer node rollup setup](/guides/full-and-sequencer-node) tutorial.
diff --git a/tutorials/gm-world-mocha-testnet.md b/tutorials/gm-world-mocha-testnet.md
@@ -1,8 +1,8 @@
-# GM world rollup: Part 3
+# GM world rollup: Part 2
 
 ## Deploying to a Celestia testnet
 
-This tutorial is part 3 of the GM world rollup tutorials. In this tutorial,
+This tutorial is part 2 of the GM world rollup tutorials. In this tutorial,
 it is expected that you've completed [part 1](./gm-world.md) of
 the tutorial and are familiar with running a local rollup devnet.
 
@@ -250,4 +250,4 @@ In the next tutorial, you'll learn how to post data to Celestia's
 Mainnet Beta.
 
 If you're interested in setting up a full node alongside your sequencer,
-see the [Full and sequencer node rollup setup](./full-and-sequencer-node) tutorial.
+see the [Full and sequencer node rollup setup](/guides/full-and-sequencer-node) tutorial.
diff --git a/tutorials/gm-world.md b/tutorials/gm-world.md
@@ -18,8 +18,8 @@ First, we will test on a local DA network, then to a live
 testnet, and lastly to mainnet.
 
 1. Part 1 (This page): Run your rollup and post DA to a local devnet, and make sure everything works as expected.
-2. [Part 2](./gm-world-arabica-testnet.md) or [Part 3](./gm-world-mocha-testnet.md): Deploy the rollup, posting to a DA testnet (arabica or mocha). Confirm again that everything is functioning properly.
-3. [Part 4](./gm-world-mainnet.md): Deploy your rollup to the DA layer's mainnet.
+2. [Part 2](./gm-world-mocha-testnet.md): Deploy the rollup, posting to a DA testnet (Mocha). Confirm again that everything is functioning properly.
+3. [Part 3](./gm-world-mainnet.md): Deploy your rollup to the DA layer's mainnet.
 
 The [Cosmos SDK](https://github.com/cosmos/cosmos-sdk) is a framework for
 building blockchain applications. The Cosmos Ecosystem uses
@@ -32,7 +32,7 @@ which is still in Alpha stage. If you run into bugs, please write a Github
 [Issue ticket](https://github.com/rollkit/docs/issues/new)
 or let us know in our [Telegram](https://t.me/rollkit).
 
-Learn how to [restart your rollup](restart-rollup.md).
+Learn how to [restart your rollup](/guides/restart-rollup.md).
 :::
 
 ## 🤔 What is GM? {#what-is-gm}

diff --git a/tutorials/overview.md b/tutorials/overview.md
@@ -1,5 +1,5 @@
 ---
-description: This page provides a comprehensive overview of tutorials and guides available for Rollkit.
+description: This page provides a comprehensive overview of tutorials available for Rollkit.
 ---
 
 # Tutorials
@@ -16,28 +16,16 @@ that best suit your needs.
 
 In this section, you'll find:
 
-* Beginner
+* Rollkit
   * [GM world rollup: Part 1, local devnet](/tutorials/gm-world.md)
-  * [GM world rollup: Part 2, arabica devnet](/tutorials/gm-world-arabica-testnet.md)
-  * [GM world rollup: Part 3, mocha testnet](/tutorials/gm-world-mocha-testnet.md)
-  * [GM world rollup: Part 4, mainnet](/tutorials/gm-world-mainnet.md)
   * [GM world frontend](/tutorials/gm-world-frontend.md)
-  * [Recipe Book rollup](/tutorials/recipe-book.md)
-  * [How to restart your rollup](/tutorials/restart-rollup.md)
-* Intermediate
   * [Wordle app](/tutorials/wordle.md)
+* DA
+  * [GM world rollup: Part 2, mocha testnet](/tutorials/gm-world-mocha-testnet.md)
+  * [GM world rollup: Part 3, mainnet](/tutorials/gm-world-mainnet.md)
+* Execution
   * [CosmWasm rollup](/tutorials/cosmwasm.md)
   * [Polaris EVM rollup](/tutorials/polaris-evm.md)
-  * [zkML rollup](/tutorials/zkml.md)
-  * [IBC connection](/tutorials/ibc-connection.md)
-* Advanced
-  * [Full and sequencer node rollup setup](/tutorials/full-and-sequencer-node.md)
-  * [Full-stack modular dapp with Celestia](https://docs.celestia.org/developers/full-stack-modular-development-guide)
-* Guides
-  * [How to configure gas price](/tutorials/gas-price.md)
-  * [How to change speed of block production](/tutorials/block-times.md)
-  * [How to use lazy sequencing (aggregation)](/tutorials/lazy-sequencing.md)
-  * [Testing and deploying smart-contract with cw-orch](/tutorials/cw-orch.md)
 
 ## 💻 Support {#support}
 

diff --git a/tutorials/polaris-evm.md b/tutorials/polaris-evm.md
@@ -15,7 +15,7 @@ is used to deploy a Polaris EVM rollup without needing to set up a data
 availability and consensus network.
 
 ::: tip
-Learn how to [restart your rollup](restart-rollup.md).
+Learn how to [restart your rollup](/guides/restart-rollup.md).
 :::
 
 ## Prerequisites

diff --git a/tutorials/recipe-book.md b/tutorials/recipe-book.md
@@ -22,7 +22,7 @@ which is still in Alpha stage. If you run into bugs, please write a Github
 [Issue ticket](https://github.com/rollkit/docs/issues/new)
 or let us know in our [Telegram](https://t.me/rollkit).
 
-Learn how to [restart your rollup](restart-rollup.md).
+Learn how to [restart your rollup](/guides/restart-rollup.md).
 :::
 
 ::: warning

diff --git a/tutorials/wordle.md b/tutorials/wordle.md
@@ -18,7 +18,7 @@ which is still in Alpha stage. If you run into bugs, please write a Github
 [Issue ticket](https://github.com/rollkit/docs/issues/new)
 or let us know in our [Telegram](https://t.me/rollkit).
 
-Learn how to [restart your rollup](restart-rollup.md).
+Learn how to [restart your rollup](/guides/restart-rollup.md).
 :::
 
 ::: warning