Skip to content

Minor updates to learn section #379

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 7 commits into from
May 16, 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
28 changes: 23 additions & 5 deletions .vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -185,11 +185,29 @@ function sidebarHome() {
text: "Learn",
collapsed: true,
items: [
{ text: "Introduction to Rollkit", link: "/learn/intro" },
{ text: "About Rollkit", link: "/learn/about" },
{ text: "Rollkit stack", link: "/learn/stack" },
{ text: "Transaction flow", link: "/learn/transaction-flow" },
{ text: "Rollkit specs", link: "https://rollkit.github.io/rollkit" },
{
text: "Overview",
collapsed: true,
items: [
{ text: "Introduction", link: "/learn/intro" },
{ text: "About Rollkit", link: "/learn/about" },
],
},
{
text: "Technical details",
collapsed: true,
items: [
{ text: "Rollkit stack", link: "/learn/stack" },
{ text: "Transaction flow", link: "/learn/transaction-flow" },
],
},
{
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

putting this in its own category with nothing else seems like it will bury it

text: "Resources",
collapsed: true,
items: [
{ text: "Technical specifications", link: "/learn/specifications" },
],
},
],
},
{
Expand Down
11 changes: 5 additions & 6 deletions learn/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,11 @@ If you're familiar with Rollkit, you may want to skip to the [tutorials section]

Rollkit is a sovereign rollup framework that gives developers the freedom to deploy rollups throughout the modular stack, opening new possibilities for rapid experimentation and innovation.

The Rollkit framework features a modular node that can run rollups and exposes an [ABCI](https://github.com/cometbft/cometbft/tree/main/abci)-compatible client interface, which can be used as a substitute for CometBFT in any ABCI-compatible blockchain application.
By default, the node utilizes Celestia as the data availability (DA) layer, however other data availability layers can be integrated.
[Read more on the Celestia blog](https://blog.celestia.org/sovereign-rollup-chains/) to learn more about the concept of sovereign rollups.

Rollkit can currently be used to deploy [sovereign rollups](https://blog.celestia.org/sovereign-rollup-chains/) or sovereign settlement layers.
Rollkit is an [open-source framework](https://github.com/rollkit/rollkit). It features a modular node that can run rollups and exposes an [ABCI-compatible client interface](https://github.com/cometbft/cometbft/tree/main/abci), which can be used as a substitute for CometBFT in any ABCI-compatible blockchain application.

Rollkit is built as an open-source framework, so that developers can easily modify it to suit their applications.
Rollkit uses data availability (DA) layers by having a unified client interface which can be implemented for use with different DA networks, such as [Celestia](https://celestia.org/).

Our goal is to empower developers to quickly innovate and create new classes of rollups with minimal trade-offs, and to make deploying a new chain as easy as deploying a smart contract.

Expand Down Expand Up @@ -82,10 +81,10 @@ Think of settlement layers as a special type of execution layer.

## When can you use Rollkit?

As of today, Rollkit is still in the MVP stages. The framework currently provides a centralized sequencer, an execution interface (ABCI or Cosmos SDK), and a connection to a data availability layer (Celestia).
As of today, Rollkit is still in the alpha stage. The framework currently provides a centralized sequencer, an execution interface (ABCI or Cosmos SDK), and a connection to a data availability layer.

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 ([Rollkit stack](/learn/stack)) 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) 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 [Tutorials](/tutorials/gm-world) section.

Spoiler alert, whichever you choose, it's going to be a great rabbit hole!
34 changes: 2 additions & 32 deletions learn/intro.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,10 @@
# Introduction to Rollkit
# Introduction

Welcome to the Rollkit docs. We're happy you made it here!
Our mission is to 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.

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

## Table of contents

### Learn

- [Introduction to Rollkit](/learn/intro)
- [About Rollkit](/learn/about)
- [Rollkit stack](/learn/stack)
- [Transaction flow](/learn/transaction-flow)
- [Building with Rollkit](/learn/building-and-deploying-a-rollup)

### Tutorials

- [Overview](/tutorials/overview)

### Testnets

- [Cosmwasm Testnet](/testnets/cosmwasm-testnet)

### Blog

- [Overview](/blog/overview)
- [Sovereign rollups on Bitcoin with Rollkit](/blog/sovereign-rollups-on-bitcoin)
4 changes: 4 additions & 0 deletions learn/specifications.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Technical specifications

[Rollkit specifications](https://rollkit.github.io/rollkit/index.html) - is comprehensive documentation on the inner components of Rollkit, including data storage, transaction processing, and more. It’s an essential resource for developers looking to understand, contribute to and leverage the full capabilities of Rollkit.

4 changes: 2 additions & 2 deletions learn/stack.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,12 @@ It's important to keep in mind that there is no direct correlation between the D

#### Celestia

Celestia is an example of a data availability integration implemented for Rollkit.
Celestia is a prominent example of a data availability integration implemented for Rollkit.
It's using the [Celestia Node API](https://node-rpc-docs.celestia.org)
via the [`rollkit/celestia-da`](https://github.com/rollkit/celestia-da) package.
To deploy a Rollkit rollup on Celestia you also have to [run a Celestia light node](https://docs.celestia.org/developers/node-tutorial/).

Use of other data availability (DA) layers is also supported by Rollkit, and research integrations for Bitcoin, Mock, gRPC are works in progress. New DA layer integrations can be added by using the [go-da](https://github.com/rollkit/go-da) interface.
New DA layer integrations can be added by using the [go-da](https://github.com/rollkit/go-da) interface.

## Node components

Expand Down
Loading