Skip to content

Commit

Permalink
docs: add some content to dev section of book (paradigmxyz#3183)
Browse files Browse the repository at this point in the history
  • Loading branch information
onbjerg authored Jun 15, 2023
1 parent 0d691fe commit 0b876de
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 4 deletions.
3 changes: 1 addition & 2 deletions book/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,4 @@
1. [reth p2p](./cli/p2p.md)
1. [reth stage](./cli/stage.md)
1. [Developers](./developers/developers.md)
1. [Contribute](./developers/contribute.md)
1. [Architecture](./developers/architecture.md)
1. [Contribute](./developers/contribute.md)
1 change: 0 additions & 1 deletion book/developers/architecture.md

This file was deleted.

8 changes: 7 additions & 1 deletion book/developers/contribute.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# Contribute

<!-- TODO: Add various debugging tips and tricks we use, ways to configure logging, unwinding a node etc. -->
<!-- TODO: Add various debugging tips and tricks we use, ways to configure logging, unwinding a node etc. -->

Reth has docs specifically geared for developers and contributors, including documentation on the structure and architecture of reth, the general workflow we employ, and other useful tips.

You can find these docs [here](https://github.com/paradigmxyz/reth/tree/main/docs).

Check out our contributing guidelines [here](https://github.com/paradigmxyz/reth/blob/main/CONTRIBUTING.md).
2 changes: 2 additions & 0 deletions book/developers/developers.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# Developers

Reth is composed of several crates that can be used in standalone projects. If you are interested in using one or more of the crates, you can get an overview of them in the [developer docs](https://github.com/paradigmxyz/reth/tree/main/docs), or take a look at the [crate docs](https://paradigmxyz.github.io/reth/docs).

0 comments on commit 0b876de

Please sign in to comment.