Skip to content
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

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

Merged
merged 18 commits into from
May 3, 2024
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
15 changes: 15 additions & 0 deletions .vitepress/components/callout.vue
Original file line number Diff line number Diff line change
@@ -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>
54 changes: 18 additions & 36 deletions .vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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)',
// },
// ],
Expand All @@ -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)',
// },
// ],
Expand All @@ -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)',
// },
// ],
Expand All @@ -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",
Expand Down Expand Up @@ -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: [
Expand Down Expand Up @@ -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" },
Expand All @@ -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" },
Expand All @@ -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",
// },
],
},
],
Expand Down
2 changes: 1 addition & 1 deletion blog/sovereign-rollups-on-bitcoin.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion guides/cw-orch.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion guides/full-and-sequencer-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions guides/ibc-connection.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
20 changes: 10 additions & 10 deletions guides/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
8 changes: 4 additions & 4 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
46 changes: 0 additions & 46 deletions learn/based-pessimistic-rollup.md

This file was deleted.

54 changes: 0 additions & 54 deletions learn/basic-rollup.md

This file was deleted.

3 changes: 1 addition & 2 deletions learn/building-and-deploying-a-rollup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand All @@ -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
Expand Down
13 changes: 2 additions & 11 deletions learn/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand Down
Loading
Loading