docs: link to book (paradigmxyz#286)

* docs: explain diff between `docs` and `book` * docs: link to book
zakisaad · Nov 29, 2022 · 8bbb9a7 · 8bbb9a7
1 parent 3ac52ba
commit 8bbb9a7
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git 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/
diff --git 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).