diff --git a/docs/the_nimbus_book/src/SUMMARY.md b/docs/the_nimbus_book/src/SUMMARY.md index f70454131..ae8d2e696 100644 --- a/docs/the_nimbus_book/src/SUMMARY.md +++ b/docs/the_nimbus_book/src/SUMMARY.md @@ -2,26 +2,27 @@ - [Introduction](./intro.md) - [Install dependencies](./install.md) - [Build the beacon node](./build.md) +- [Start syncing](./start-syncing.md) - [Make a deposit](./deposit.md) - [Manage your keys](./keys.md) - [Connect to eth2](./connect-eth2.md) -- [Run your node on a Raspberry Pi](./pi-guide.md) - [Keep an eye on your validator](./keep-an-eye.md) - [Keep your validator updated](./keep-updated.md) - [Useful pre-genesis checks]() # Volume 2 +- [Troubleshooting](./troubleshooting.md) +- [Run your node on a Raspberry Pi](./pi-guide.md) - [Metrics and pretty pictures](./metrics-pretty-pictures.md) +- [Infura guide](infura-guide.md) +- [eth2stats guide]() - [Graffiti the blockchain](./graffiti.md) - [Run a local eth1 node]() - [Run just the beacon node]() - [Switch between clients]() - [Permissions]() -- [Advanced options](./advanced.md) -- [Troubleshooting](./troubleshooting.md) -- [API](./api.md) -- [Infura guide](infura-guide.md) -- [eth2stats guide]() # Volume 3 +- [Advanced options](./advanced.md) +- [API](./api.md) - [For developers](./developers.md) - [Set up a systemd service](./beacon-node-systemd.md) - [Generate your keys with Nimbus](./create-wallet-and-deposit.md) diff --git a/docs/the_nimbus_book/src/connect-eth2.md b/docs/the_nimbus_book/src/connect-eth2.md index 99f433eaa..1c1826ba4 100644 --- a/docs/the_nimbus_book/src/connect-eth2.md +++ b/docs/the_nimbus_book/src/connect-eth2.md @@ -1,12 +1,14 @@ # Connect to eth2 -From the `nimbus-eth2` repository, run: +To connect to the Medalla testnet, from the `nimbus-eth2` repository run: ``` make medalla ``` -This will build Nimbus and its dependencies, and connect you to the Medalla testnet. +> **Note:** If your beacon node is already running, you'll need to shut it down gracefully (`Ctrl+c`) and re-run the above command. + +This will build Nimbus and its dependencies, and connect you to the eth2 network. You should see that the beacon node has launched with your validator attached: ``` diff --git a/docs/the_nimbus_book/src/start-syncing.md b/docs/the_nimbus_book/src/start-syncing.md new file mode 100644 index 000000000..c74c18f48 --- /dev/null +++ b/docs/the_nimbus_book/src/start-syncing.md @@ -0,0 +1,17 @@ +# Start syncing + +To avoid being hit with minor penalties, the beacon node should be [completely synced](./keep-an-eye.md#keep-track-of-your-syncing-progress) before submitting your deposit. + +This is particularly important if you are joining a network that's been running for a while. + +To start syncing `medalla` , from the `nimbus-eth2` repository, run: + +``` +make medalla +``` + +> **Note:** If you planning on [making a deposit](./deposit.md) before the network you'd like to join has launched -- whether mainnet or a testnet -- you can safely skip this step. + + + +