Skip to content

Commit 4886bca

Browse files
yarikbratashchukjcsteincoderabbitai[bot]
authored
Minor updates to learn section (#379)
* Minor updates to learn section * Apply suggestions from code review to config.ts * Apply suggestions from code review * Apply suggestions from code review Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Apply suggestions from code review * Apply suggestions from code review * Apply suggestions from code review --------- Co-authored-by: joshcs.eth <46639943+jcstein@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
1 parent e48c32b commit 4886bca

File tree

5 files changed

+36
-45
lines changed

5 files changed

+36
-45
lines changed

.vitepress/config.ts

+23-5
Original file line numberDiff line numberDiff line change
@@ -185,11 +185,29 @@ function sidebarHome() {
185185
text: "Learn",
186186
collapsed: true,
187187
items: [
188-
{ text: "Introduction to Rollkit", link: "/learn/intro" },
189-
{ text: "About Rollkit", link: "/learn/about" },
190-
{ text: "Rollkit stack", link: "/learn/stack" },
191-
{ text: "Transaction flow", link: "/learn/transaction-flow" },
192-
{ text: "Rollkit specs", link: "https://rollkit.github.io/rollkit" },
188+
{
189+
text: "Overview",
190+
collapsed: true,
191+
items: [
192+
{ text: "Introduction", link: "/learn/intro" },
193+
{ text: "About Rollkit", link: "/learn/about" },
194+
],
195+
},
196+
{
197+
text: "Technical details",
198+
collapsed: true,
199+
items: [
200+
{ text: "Rollkit stack", link: "/learn/stack" },
201+
{ text: "Transaction flow", link: "/learn/transaction-flow" },
202+
],
203+
},
204+
{
205+
text: "Resources",
206+
collapsed: true,
207+
items: [
208+
{ text: "Technical specifications", link: "/learn/specifications" },
209+
],
210+
},
193211
],
194212
},
195213
{

learn/about.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,11 @@ If you're familiar with Rollkit, you may want to skip to the [tutorials section]
1212

1313
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.
1414

15-
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.
16-
By default, the node utilizes Celestia as the data availability (DA) layer, however other data availability layers can be integrated.
15+
[Read more on the Celestia blog](https://blog.celestia.org/sovereign-rollup-chains/) to learn more about the concept of sovereign rollups.
1716

18-
Rollkit can currently be used to deploy [sovereign rollups](https://blog.celestia.org/sovereign-rollup-chains/) or sovereign settlement layers.
17+
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.
1918

20-
Rollkit is built as an open-source framework, so that developers can easily modify it to suit their applications.
19+
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/).
2120

2221
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.
2322

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

8382
## When can you use Rollkit?
8483

85-
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).
84+
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.
8685

8786
We're currently working on implementing many new and exciting features such as light nodes and state fraud proofs.
8887

89-
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.
88+
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.
9089

9190
Spoiler alert, whichever you choose, it's going to be a great rabbit hole!

learn/intro.md

+2-32
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,10 @@
1-
# Introduction to Rollkit
1+
# Introduction
22

33
Welcome to the Rollkit docs. We're happy you made it here!
4+
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.
45

56
Rollkit is the first sovereign rollup framework.
67

78
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.
89

910
We're setting the bar high for developers' flexibility and ability to customize rollups however they see fit.
10-
11-
::: tip
12-
In order to use Rollkit, it's important to have some
13-
familiarity with Cosmos SDK. You can get up to speed
14-
on Cosmos SDK by visiting their [official documentation page](https://docs.cosmos.network/main).
15-
16-
If you're familiar with Rollkit, you may want to skip to the [tutorials section](/tutorials/gm-world).
17-
:::
18-
19-
## Table of contents
20-
21-
### Learn
22-
23-
- [Introduction to Rollkit](/learn/intro)
24-
- [About Rollkit](/learn/about)
25-
- [Rollkit stack](/learn/stack)
26-
- [Transaction flow](/learn/transaction-flow)
27-
- [Building with Rollkit](/learn/building-and-deploying-a-rollup)
28-
29-
### Tutorials
30-
31-
- [Overview](/tutorials/overview)
32-
33-
### Testnets
34-
35-
- [Cosmwasm Testnet](/testnets/cosmwasm-testnet)
36-
37-
### Blog
38-
39-
- [Overview](/blog/overview)
40-
- [Sovereign rollups on Bitcoin with Rollkit](/blog/sovereign-rollups-on-bitcoin)

learn/specifications.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Technical specifications
2+
3+
[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+

learn/stack.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,12 @@ It's important to keep in mind that there is no direct correlation between the D
4747

4848
#### Celestia
4949

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

55-
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.
55+
New DA layer integrations can be added by using the [go-da](https://github.com/rollkit/go-da) interface.
5656

5757
## Node components
5858

0 commit comments

Comments
 (0)