forked from paradigmxyz/reth
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Draft Layout for Reth walkthrough (paradigmxyz#344)
- Loading branch information
Showing
3 changed files
with
81 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,19 @@ | ||
| # reth Book | ||
|
|
||
| *Documentation for reth users.* | ||
| <img src="images/" style="border-radius: 20px"> | ||
|
|
||
| reth is an Ethereum execution client. | ||
| <!-- Add a quick description about Reth, what it is, the goals of the build, and any other quick overview information --> | ||
|
|
||
|
|
||
| > 📖 **Contributing** | ||
| > | ||
| > You can contribute to this book on [GitHub](). | ||
| ### Sections | ||
|
|
||
| **[Getting Started]()** | ||
| To get started with Reth, install, configure and sync your node. | ||
|
|
||
| **[A Tour Of Reth]()** | ||
|
|
||
| This section will take a deep dive into the inner workings of Reth. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,50 @@ | ||
| # Summary | ||
|
|
||
| [Introduction](./README.md) | ||
|
|
||
| # Getting Started | ||
|
|
||
| - [Installation]() | ||
| - [First Steps with Reth]() | ||
| <!-- An overview of all the flags, how they work and how to configure the node --> | ||
| - [Configuring The Node]() | ||
| - [Running Reth]() | ||
|
|
||
| # A Tour Of Reth | ||
|
|
||
| - [Database]() | ||
| - [codecs]() | ||
| - [libmdbx-rs]() | ||
| - [db]() | ||
| - [Networking]() | ||
| - [P2P]() | ||
| - [network]() | ||
| - [eth-wire]() | ||
| - [discv4]() | ||
| - [ipc]() | ||
| - [RPC]() | ||
| - [rpc-api]() | ||
| - [rpc]() | ||
| - [rpc-types]() | ||
| - [Downloaders]() | ||
| - [bodies-downloaders]() | ||
| - [headers-downloaders]() | ||
| - [Ethereum]() | ||
| - [executor]() | ||
| - [consensus]() | ||
| - [transaction-pool]() | ||
| - [Staged Sync]() | ||
| - [stages]() | ||
| - [Primitives]() | ||
| - [primitives]() | ||
| - [rlp]() | ||
| - [rlp-derive]() | ||
| - [Misc]() | ||
| - [interfaces]() | ||
| - [tracing]() | ||
| - [crate-template]() | ||
| - [examples]() | ||
|
|
||
|
|
||
|
|
||
| # Design | ||
|
|
||
| - [Goals](./design/goals.md) | ||
| - [Goals](./design/goals.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| [book] | ||
| authors = [""] | ||
| language = "en" | ||
| multilingual = false | ||
| src = "src" | ||
| title = "Reth Book" | ||
| description = "A book on all things Reth" | ||
|
|
||
| [output.html] | ||
| git-repository-url = "https://github.com/foundry-rs/reth" | ||
| edit-url-template = "" | ||
| default-theme = "ayu" | ||
| cname = "" | ||
| no-section-label = true | ||
| additional-css = [""] | ||
|
|
||
| [output.html.fold] | ||
| enable = true | ||
| level = 1 |