Files
nanoreth/book/README.md
0xKitsune df9d14127d Reth Book - Stages framework/draft (#360)
* Added framework and start to draft for stages, stopping here to get feedback on approach before pushing forward

* Update README.md

Fixing some wording / grammar.

* Fixing grammar/wording.

* Added note about non-exhaustive stages list, fixed grammar, fixed State exectuion function name, updated language to reflect that the stream yields a SealedHeader and added language to describe that the initial header validation is only a basic validation.

* updated stages chapter, added bodies, senders, execution, next chapter prelude

* typo

* Added line numbers to code snippets for the stages chapter of the reth book

* address reverse header download + other nits

* add note about book hosting

* tweaked wording, formatting

* Address typo "staring"

* Address typo "HeadderDownloader"

* consolidated book.toml

* updating snippets in stages chapter to ignore errors

* template & removed empty fields from book.toml

* addressed build issues, added templating for source code

* only deploy on push to main

* using single quotes in github action if expression

Co-authored-by: Andrew Kirillov <andrew@paradigm.xyz>
Co-authored-by: Andrew Kirillov <20803092+akirillo@users.noreply.github.com>
2022-12-14 10:30:45 +02:00

23 lines
610 B
Markdown

# reth Book
<img src="images/" style="border-radius: 20px">
<!-- Add a quick description about Reth, what it is, the goals of the build, and any other quick overview information -->
The book is continuously rendered [here](https://paradigmxyz.github.io/reth/)!
> 📖 **Contributing**
>
> You can contribute to this book on [GitHub][gh-book].
### 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.
[gh-book]: https://github.com/paradigmxyz/reth/tree/main/book