Commit Graph

14 Commits

Author SHA1 Message Date
8e89360774 feat: release workflow (#2677) 2023-05-19 19:48:23 +02:00
52f2bc5ebc docs: rework book (#2566) 2023-05-04 20:28:33 -07:00
75fab00111 fix(book): incorrect paths for book pages (#889) 2023-01-15 11:52:05 +01:00
e9cc416d7a feat(doc): Bootstrap MacOS runbook (#822) 2023-01-12 17:53:49 +01:00
19f4132eb4 chore: fix typo in book (#719)
* Rename matrics -> metrics

* Rephrase some cmd-line option descriptions
2023-01-04 20:30:34 +02:00
97d87409bc Reth book for user (#666)
* add reth book structur

* introduction to reth

* add system requirement

* update docs

* Add node detail

* add Disclaimer for disk estimate

* add Disclaimer for disk estimate

* add comman-line options

* matrics docs

* add logs docs

* remove disk usage for now

* Add disable-discovery flag in cli docs #597

Co-authored-by: Satoshi Okamoto <satoshi@butcher73.com>
2023-01-01 17:16:53 +02:00
d4d8a8c882 Moves code walkthrough book chapters to docs (#629)
* replaced template blocks with code blocks in stages chapter

* replaced template blocks with code blocks in network chapter

* moved book sections to docs

* fix indentation in recover_signer codeblock

* remove unnecessary TODO comment in network.md
2022-12-28 10:24:39 +01:00
a51fa4fd63 docs(book): start book chapter for network crate (#445)
* WIP FOR DRAFT PR

* WIP draft, walking through usage in pipeline

* diving deeper into instantiation of NetworkHandle & FetchClient

* WIP network management task & eth requests task done (ish)

* address pr comments: networkmanager as standalone task, networkconfig as main entrypoint for setup

* complete draft of the  crate docs

* restructured, starts w/ expl of

* added more snippets/anchors

* using ignore flag on code blocks, brief explanation of  struct

* typos addressed
2022-12-27 14:53:15 -08:00
daa65e7f58 docs: expose db on book summary 2022-12-26 18:27:53 +02:00
4c298ac022 docs: macos install steps (#460)
* Add MacOS installatin docs

* move installatio instruction to book

* move installatio instruction to book

* fix installation link in readme

* Remove installation link from docs, add link to installation in book summary

Co-authored-by: Satoshi Okamoto <satoshi@butcher73.com>
2022-12-15 12:55:59 +01:00
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
ce8f61f0a5 Draft Layout for Reth walkthrough (#344) 2022-12-06 18:02:04 -08:00
a2817881db feat(docs): start goals doc in book (#233)
* started goals doc in book

* typos + elaborating on performance rationale

* Update book/design/goals.md

Co-authored-by: Georgios Konstantopoulos <me@gakonst.com>
2022-11-24 03:43:30 -08:00
edc75881c1 docs: add book skeleton (#44)
* docs: add book skeleton

* ci: add book test workflow
2022-10-11 18:52:28 +02:00