Added Quick start guide and simplified gm-world tutorial (#360)

* Add Quick Start tutorial - add script for installing Go from source, platform agnostic - add script for installing Rollkit cli by building it from source under the hood * Update main cta to "quick start" * Remove tutorials overview page * Simplify gm-world tutorial and use local-da * Pass version for go/rollkit/mockda as a first arg, install jq, fix rawgithub links * Update mockda version to v0.1.0 * Fix typos * Fix typos * modify tagline * Make install to make build * feat: add specs to menu * feat: use all scripts from public dir, remove unused assets, move img to public dir, linting * feat: remove rollup glossary * feat: merge intro/learn categories * fix: cleanup * feat: resolve #362 * feat: refactor callout into component --------- Co-authored-by: Manav Aggarwal <[email protected]> Co-authored-by: jcstein <[email protected]>
rollkit · May 3, 2024 · 524221b · 524221b
1 parent 6419145
commit 524221b
Show file tree

Hide file tree

Showing 67 changed files with 466 additions and 1,643 deletions.
diff --git a/.vitepress/components/callout.vue b/.vitepress/components/callout.vue
@@ -0,0 +1,15 @@
+<template>
+    <div>
+        <p>This tutorial explores Rollkit, currently in Alpha. If you encounter bugs, please report them via a GitHub <a href="https://github.com/rollkit/docs/issues/new">issue ticket</a> or reach out in our <a href="https://t.me/rollkit">Telegram group</a>.</p>
+    </div>
+</template>
+
+<script>
+export default {
+    name: 'Callout',
+}
+</script>
+
+<style scoped>
+/* Add any custom styles for the component here */
+</style>
diff --git a/.vitepress/config.ts b/.vitepress/config.ts
@@ -20,14 +20,14 @@ export default withMermaid({
   },
 
   head: [
-    ["link", { rel: "icon", href: "/favicon.svg", type: "image/svg+xml" }],
-    ["link", { rel: "icon", href: "/favicon.png", type: "image/png" }],
+    ["link", { rel: "icon", href: "/img/favicon.svg", type: "image/svg+xml" }],
+    ["link", { rel: "icon", href: "/img/favicon.png", type: "image/png" }],
     // [
     //   'link',
     //   {
     //     rel: 'icon',
     //     type: 'image/svg+xml',
-    //     href: '/favicon-dark.svg',
+    //     href: '/img/favicon-dark.svg',
     //     media: '(prefers-color-scheme: dark)',
     //   },
     // ],
@@ -36,7 +36,7 @@ export default withMermaid({
     //   {
     //     rel: 'icon',
     //     type: 'image/png',
-    //     href: '/favicon-dark.png',
+    //     href: '/img/favicon-dark.png',
     //     media: '(prefers-color-scheme: dark)',
     //   },
     // ],
@@ -49,7 +49,7 @@ export default withMermaid({
     //   {
     //     rel: 'icon',
     //     type: 'image/x-icon',
-    //     href: '/favicon-dark.ico',
+    //     href: '/img/favicon-dark.ico',
     //     media: '(prefers-color-scheme: dark)',
     //   },
     // ],
@@ -74,10 +74,10 @@ export default withMermaid({
     ],
     ["meta", { httpEquiv: "Content-Language", content: "en" }],
     ["meta", { name: "twitter:card", content: "summary_large_image" }],
-    ["meta", { name: "twitter:image", content: "/Rollkit-og.png" }],
+    ["meta", { name: "twitter:image", content: "/img/Rollkit-og.png" }],
     ["meta", { name: "twitter:site:domain", content: "rollkit.dev" }],
     ["meta", { name: "twitter:url", content: "https://rollkit.dev" }],
-    ["meta", { name: "og:image", content: "/Rollkit-og.png" }],
+    ["meta", { name: "og:image", content: "/img/Rollkit-og.png" }],
     ["meta", { name: "apple-mobile-web-app-title", content: "Rollkit" }],
     [
       "script",
@@ -136,8 +136,8 @@ export default withMermaid({
 
     logo: {
       alt: "Rollkit Logo",
-      light: "/logo.svg",
-      dark: "/logo-dark.svg",
+      light: "/img/logo.svg",
+      dark: "/img/logo-dark.svg",
     },
 
     socialLinks: [
@@ -167,9 +167,8 @@ export default withMermaid({
 
 function nav() {
   return [
-    { text: "Intro", link: "/learn/intro" },
-    { text: "Learn", link: "/learn/overview" },
-    { text: "Tutorials", link: "/tutorials/overview" },
+    { text: "Learn", link: "/learn/intro" },
+    { text: "Tutorials", link: "/tutorials/quick-start" },
     { text: "How To Guides", link: "/guides/overview" },
     { text: "Testnets", link: "/testnets/cosmwasm-testnet" },
     { text: "Blog", link: "/blog/overview" },
@@ -179,43 +178,30 @@ function nav() {
 function sidebarHome() {
   return [
     {
-      text: "Introduction",
+      text: "Learn",
       collapsed: true,
       items: [
         { text: "Introduction to Rollkit", link: "/learn/intro" },
         { text: "About Rollkit", link: "/learn/about" },
-      ],
-    },
-    {
-      text: "Learn",
-      collapsed: true,
-      items: [
-        { text: "Overview", link: "/learn/overview" },
         { text: "Rollkit stack", link: "/learn/stack" },
         { text: "Transaction flow", link: "/learn/transaction-flow" },
-        {
-          text: "Rollup Wiki",
-          collapsed: true,
-          items: [
-            { text: "A-Z glossary", link: "/learn/rollup-glossary" },
-            // { text: 'Basic Rollup', link: '/learn/basic-rollup' },
-          ],
-        },
+        { text: "Rollkit specs", link: "rollkit.github.io/rollkit" },
       ],
     },
     {
       text: "Tutorials",
       collapsed: true,
       items: [
-        { text: "Overview", link: "/tutorials/overview" },
         {
           text: "Rollkit",
           collapsed: true,
           items: [
-            // { text: 'Starter Rollup with Docker', link: '/tutorials/rollup-docker'},
-            // { text: 'Starter Rollup', link: '/tutorials/starter-rollup'},
             {
-              text: "GM world rollup: Part 1, local devnet",
+              text: "Quick start guide",
+              link: "/tutorials/quick-start",
+            },
+            {
+              text: "GM world rollup",
               link: "/tutorials/gm-world",
             },
             { text: "GM world frontend", link: "/tutorials/gm-world-frontend" },
@@ -242,10 +228,6 @@ function sidebarHome() {
           items: [
             { text: "CosmWasm rollup", link: "/tutorials/cosmwasm" },
             { text: "Polaris EVM rollup", link: "/tutorials/polaris-evm" },
-            // {
-            //   text: "Full-stack modular dapp with Celestia",
-            //   link: "https://docs.celestia.org/developers/full-stack-modular-development-guide",
-            // },
           ],
         },
       ],

diff --git a/blog/sovereign-rollups-on-bitcoin.md b/blog/sovereign-rollups-on-bitcoin.md
@@ -11,7 +11,7 @@ head:
       content: Rollkit, Celestia
   - - meta
     - name: og:image
-      content: /introducing-rollkit/rollkit-blog-cover.png
+      content: /img/introducing-rollkit/rollkit-blog-cover.png
 ---
 
 # Sovereign rollups on Bitcoin with Rollkit

diff --git a/guides/cw-orch.md b/guides/cw-orch.md
@@ -219,7 +219,7 @@ members = ["packages/*", "contracts/*", "interface"]
 
 Inside this `interface` crate, we advise to integrate all your contracts 1 by 1 in separate files. Here is the structure of the `cw-plus` integration for reference:
 
-```path
+```bash
 interface (interface collection)
 ├── Cargo.toml
 └── src

diff --git a/guides/full-and-sequencer-node.md b/guides/full-and-sequencer-node.md
@@ -47,7 +47,7 @@ Now, clone the script for the full node:
 ```bash
 # From inside the `gm` directory
 cd $HOME/gm
-wget https://raw.githubusercontent.com/rollkit/docs/main/scripts/gm/init-full-node.sh
+wget https://rollkit.dev/gm/init-full-node.sh
 ```
 
 ### Set DA height

diff --git a/guides/ibc-connection.md b/guides/ibc-connection.md
@@ -56,7 +56,7 @@ go mod download
 Now download the script to run the GM chain:
 
 ```bash
-wget https://raw.githubusercontent.com/rollkit/docs/main/scripts/gm/init-local.sh
+wget https://rollkit.dev/gm/init-local.sh
 ```
 
 Run the GM rollup:
@@ -86,7 +86,7 @@ make install
 You also need to start local-osmosis-testnet in a separate terminal by downloading and running this script:
 
 ```bash
-wget https://raw.githubusercontent.com/rollkit/docs/main/scripts/ibc/init-osmosis-local.sh
+wget https://rollkit.dev/ibc/init-osmosis-local.sh
 ```
 
 Run the script:

diff --git a/guides/overview.md b/guides/overview.md
@@ -14,19 +14,19 @@ 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)
-  * [How to integrate Range with your rollup](/guides/rollkit-monitoring.md)
+* [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)
+* [How to integrate Range with your rollup](/guides/rollkit-monitoring.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
+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/index.md b/index.md
@@ -6,14 +6,14 @@ titleTemplate: ':title'
 hero:
   name: "Rollkit"
   text: "The first sovereign rollup framework"
-  tagline: Rollkit utilizes the shared security of a modular data availability network to allow anyone to launch their own sovereign, customizable blockchain as easily as a smart contract
+  tagline: Rollkit allows anyone to launch their own sovereign, customizable blockchain as easily as a smart contract
   image:
-    src: /logo-big.svg
+    src: /img/logo-big.svg
     alt: Rollkit
   actions:
     - theme: brand
-      text: Starter Rollup
-      link: /tutorials/gm-world
+      text: Quick start 
+      link: /tutorials/quick-start
     - theme: alt
       text: Introduction
       link: /learn/intro

diff --git a/learn/based-pessimistic-rollup.md b/learn/based-pessimistic-rollup.md
diff --git a/learn/basic-rollup.md b/learn/basic-rollup.md
diff --git a/learn/building-and-deploying-a-rollup.md b/learn/building-and-deploying-a-rollup.md
@@ -12,7 +12,6 @@ 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](/guides/restart-rollup)
 
 ## 2️. Intermediate {#intermediate}
@@ -27,7 +26,7 @@ You can get started with the following tutorials:
 ## 💻 Support {#support}
 
 The tutorials will explore developing with Rollkit,
-which is still in Alpha stage. If you run into bugs, please write a Github
+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).
 Furthermore, while Rollkit allows you to build sovereign rollups

diff --git a/learn/intro.md b/learn/intro.md
@@ -6,7 +6,6 @@ Rollkit is the first sovereign rollup framework.
 
 Our mission is allow anyone to launch their own sovereign, customizable blockchain as easily as a smart contract by utilizing the shared security of a modular data availability network.
 
-
 We're setting the bar high for developers' flexibility and ability to customize rollups however they see fit.
 
 ::: tip
@@ -19,25 +18,17 @@ If you're familiar with Rollkit, you may want to skip to the [tutorials section]
 
 ## Table of contents
 
-### Introduction
+### Learn
 
 - [Introduction to Rollkit](/learn/intro)
 - [About Rollkit](/learn/about)
-
-### Learn
-
-- [Overview](/learn/overview)
 - [Rollkit stack](/learn/stack)
 - [Transaction flow](/learn/transaction-flow)
 - [Building with Rollkit](/learn/building-and-deploying-a-rollup)
 
-#### Rollup Wiki
-
-- [A-Z glossary](/learn/rollup-glossary)
-
 ### Tutorials
 
-[Overview](/tutorials/overview)
+- [Overview](/tutorials/overview)
 
 ### Testnets