docs: rework book (paradigmxyz#2566)

imotai · May 5, 2023 · 52f2bc5 · 52f2bc5
1 parent 70bcd76
commit 52f2bc5
Show file tree

Hide file tree

Showing 32 changed files with 537 additions and 251 deletions.
diff --git a/book/README.md b/book/README.md
diff --git a/book/SUMMARY.md b/book/SUMMARY.md
@@ -1,17 +1,27 @@
 # Reth Book
 
-## Getting Started
-- [Introduction](./README.md)
-- [System requirements](./getting_started/system_requirements.md)
-- [Installation](./getting_started/installation.md)
-- [Running Reth](./getting_started/running.md)
-
-## Fundamentals
-- [Node](./fundamentals/node.md)
-- [Command-Line Options](./fundamentals/command-line_options.md)
-- [Logs](./fundamentals/logs.md)
-
-## Monitoring
-- [Metrics](./monitoring/metrics.md)
-
-## [FAQ](./faq/README.md)
+1. [Introduction](./intro.md)
+1. [Installation](./installation/installation.md)
+    1. [Pre-Built Binaries](./installation/binaries.md)
+    1. [Docker](./installation/docker.md)
+    1. [Build from Source](./installation/source.md)
+1. [Run a Node](./run/run-a-node.md)
+    1. [Mainnet or official Testnets](./run/mainnet.md)
+    1. [Local Testnet](./run/local_testnet.md)
+    1. [Observability with Prometheus & Grafana](./run/observability.md)
+    1. [Configuring reth.toml](./run/config.md)
+1. [Interacting with Reth over JSON-RPC](./jsonrpc/intro.md)
+    1. [admin](./jsonrpc/admin.md)
+    1. [eth](./jsonrpc/eth.md)
+    1. [engine](./jsonrpc/engine.md)
+    1. [tracing](./jsonrpc/tracing.md)
+1. [CLI Reference](./cli/cli.md)
+    1. [reth node](./cli/node.md) -->
+    1. [reth db](./cli/db.md)
+    1. [reth p2p](./cli/p2p.md)
+    1. [reth stage](./cli/stage.md)
+    1. [reth dump-stage](./cli/dump-stage.md)
+    1. [reth drop-stage](./cli/drop-stage.md)
+1. [Developers](./developers/developers.md)
+    1. [Contribute](./developers/contribute.md)
+    1. [Architecture](./developers/architecture.md)
diff --git a/book/cli/cli.md b/book/cli/cli.md
@@ -0,0 +1 @@
+# CLI Reference
diff --git a/book/cli/db.md b/book/cli/db.md
@@ -0,0 +1 @@
+# reth db
diff --git a/book/cli/drop-stage.md b/book/cli/drop-stage.md
@@ -0,0 +1 @@
+# reth drop-stage
diff --git a/book/cli/dump-stage.md b/book/cli/dump-stage.md
@@ -0,0 +1 @@
+# reth dump-stage
diff --git a/book/cli/node.md b/book/cli/node.md
@@ -0,0 +1 @@
+# reth node
diff --git a/book/cli/p2p.md b/book/cli/p2p.md
@@ -0,0 +1 @@
+# reth p2p
diff --git a/book/cli/stage.md b/book/cli/stage.md
@@ -0,0 +1 @@
+# reth stage
diff --git a/book/developers/architecture.md b/book/developers/architecture.md
@@ -0,0 +1 @@
+# Architecture
diff --git a/book/developers/contribute.md b/book/developers/contribute.md
@@ -0,0 +1,3 @@
+# Contribute
+
+<!-- TODO: Add various debugging tips and tricks we use, ways to configure logging, unwinding a node etc. -->
diff --git a/book/developers/developers.md b/book/developers/developers.md
@@ -0,0 +1 @@
+# Developers
diff --git a/book/getting_started/installation.md b/book/getting_started/installation.md
diff --git a/book/getting_started/introduction.md b/book/getting_started/introduction.md
diff --git a/book/getting_started/running.md b/book/getting_started/running.md
diff --git a/book/getting_started/system_requirements.md b/book/getting_started/system_requirements.md
diff --git a/book/installation/binaries.md b/book/installation/binaries.md
@@ -0,0 +1,57 @@
+# Binaries
+
+Precompiled binaries are available from the [GitHub releases page](https://github.com/paradigmxyz/reth/releases).
+These are better managed by using [rethup](#using-rethup).
+
+## Rethup
+
+rethup is the Reth installer. It is a wrapper around the GitHub releases page, and allows you to install Reth from a specific branch, commit, or pull request from your terminal, easily.
+
+Open your terminal and run the following command:
+
+```sh
+curl -L https://reth.paradigm.xyz | bash
+```
+
+This will install rethup, then simply follow the instructions on-screen,
+which will make the `rethup` command available in your CLI.
+
+Running `rethup` by itself will install the latest (nightly) precompiled binary for `reth`.
+See `rethup --help` for more options, like installing from a specific version or commit.
+
+> ℹ️ **Note**
+>
+> If you're on Windows, you will need to install and use [Git BASH](https://gitforwindows.org/) or [WSL](https://learn.microsoft.com/en-us/windows/wsl/install),
+> as your terminal, since rethup currently does not support Powershell or Cmd.
+
+You can use the different rethup flags to install reth from a specific branch, pull request, or path.
+
+```sh
+rethup --branch master
+rethup --path path/to/reth
+rethup --pr 1234
+```
+
+## From Github Releases
+
+Alternatively, you can download the binaries from the [GitHub releases page](https://github.com/paradigmxyz/reth/releases).
+
+Binaries are supplied for four platforms:
+
+- `x86_64-unknown-linux-gnu`: AMD/Intel 64-bit processors (most desktops, laptops, servers)
+- `x86_64-apple-darwin`: macOS with Intel chips
+- `aarch64-unknown-linux-gnu`: 64-bit ARM processors (Raspberry Pi 4)
+- `x86_64-windows`: Windows with 64-bit processors
+
+Each binary is contained in a `.tar.gz` archive. For this example, lets assume the user needs
+a `x86_64` binary:
+1. Go to the [Releases](https://github.com/paradigmxyz/reth/releases) page and
+   select the latest release.
+1. Download the `reth-${VERSION}-x86_64-unknown-linux-gnu.tar.gz` binary. For example, to obtain the binary file for v0.0.1 (the latest version at the time of writing), a user can run the following commands in a linux terminal:
+    ```bash
+    cd ~
+    curl -LO https://github.com/paradigmxyz/reth/releases/download/v0.0.1-alpha/reth-v0.0.1-alpha-x86_64-unknown-linux-gnu.tar.gz
+    tar -xvf reth-v0.0.1-alpha-x86_64-unknown-linux-gnu.tar.gz
+    ```
+1. Test the binary with `./reth --version` (it should print the version).
+1. (Optional) Move the `reth` binary to a location in your `PATH`, so the `reth` command can be called from anywhere. For example, to copy `reth` from the current directory to `usr/bin`, run `sudo cp reth /usr/bin`.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Contribute

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