mirror of
https://github.com/hl-archive-node/nanoreth.git
synced 2025-12-06 10:59:55 +00:00
Draft Layout for Reth walkthrough (#344)
This commit is contained in:
committed by
Georgios Konstantopoulos
parent
a0a40a9c3d
commit
ce8f61f0a5
@ -1,5 +1,19 @@
|
|||||||
# reth Book
|
# 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.
|
||||||
|
|||||||
@ -1,7 +1,50 @@
|
|||||||
# Summary
|
|
||||||
|
|
||||||
[Introduction](./README.md)
|
[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
|
# Design
|
||||||
|
|
||||||
- [Goals](./design/goals.md)
|
- [Goals](./design/goals.md)
|
||||||
19
book/book.toml
Normal file
19
book/book.toml
Normal file
@ -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
|
||||||
Reference in New Issue
Block a user