From 8bbb9a71db930d3d8780dedbe5e835021fca9f6b Mon Sep 17 00:00:00 2001 From: Bjerg Date: Tue, 29 Nov 2022 11:33:50 +0100 Subject: [PATCH] docs: link to book (#286) * docs: explain diff between `docs` and `book` * docs: link to book --- README.md | 4 +++- docs/repo/layout.md | 4 ++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 650c78399..dafaf216f 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,10 @@ Rust minimum required version to build this project is 1.65.0 published 02.11.20 ## Docs -Contributor docs can be found [here](./docs). +- [User docs][book] +- [Contributor docs](./docs) [codecov]: https://app.codecov.io/gh/foundry-rs/reth [gh-ci]: https://github.com/foundry-rs/reth/actions/workflows/ci.yml [gh-deny]: https://github.com/foundry-rs/reth/actions/workflows/deny.yml +[book]: https://foundry-rs.github.io/reth/ \ No newline at end of file diff --git a/docs/repo/layout.md b/docs/repo/layout.md index 017a31c82..af2f3fd1a 100644 --- a/docs/repo/layout.md +++ b/docs/repo/layout.md @@ -2,6 +2,10 @@ This repository contains several Rust crates that implement the different building blocks of an Ethereum node. The high-level structure of the repository is as follows: +### Documentation + +Contributor documentation is in [`docs`](../../docs) and end-user documentation is in [`book`](../../book). + ### Binaries All binaries are stored in [`bin`](../../bin).