diff --git a/docs/the_nimbus_book/src/SUMMARY.md b/docs/the_nimbus_book/src/SUMMARY.md index 06763ee56..6a3eb4461 100644 --- a/docs/the_nimbus_book/src/SUMMARY.md +++ b/docs/the_nimbus_book/src/SUMMARY.md @@ -1,6 +1,15 @@ # Summary +# Introduction - [Introduction](./intro.md) +- [Philosophy]() - [System requirements](./hardware.md) + +# Raspberry Pi +- [Run your node on a Raspberry Pi](./pi-guide.md) +- [Mainnet advice](./pi-guide-mainnet.md) + +# How-to + - [Install dependencies](./install.md) - [Build the beacon node](./build.md) - [Run an eth1 node](./eth1.md) @@ -12,25 +21,25 @@ - [Keep Nimbus updated](./keep-updated.md) - [Mainnet preparations](./preparation.md) - [Email notifications](./email-notifications.md) -# Volume 2 -- [Command line options](./options.md) -- [Troubleshooting](./troubleshooting.md) +- [Graffiti the blockchain](./graffiti.md) - [Nimbus binaries](./binaries.md) +- [Troubleshooting](./troubleshooting.md) + +# Tutorials - [Grafana and Prometheus](metrics-pretty-pictures.md) - [Network stats + monitoring](./eth2-stats.md) -- [Run your node on a Raspberry Pi](./pi-guide.md) -- [Raspberry Pi: Mainnet advice](./pi-guide-mainnet.md) -- [Graffiti the blockchain](./graffiti.md) +- [Set up a systemd service](./beacon-node-systemd.md) - [Your own Infura endpoint](infura-guide.md) - [Perform a voluntary exit](voluntary-exit.md) - [Run just the beacon node]() - [Switch between clients]() -# Volume 3 + +# Reference - [Advanced options]() - [Windows users]() - [API](./api.md) +- [Command line options](./options.md) - [For developers](./developers.md) -- [Set up a systemd service](./beacon-node-systemd.md) - [FAQ](./faq.md) - [Contribute](./contribute.md) - [Resources](./resources.md) diff --git a/docs/the_nimbus_book/src/graffiti.md b/docs/the_nimbus_book/src/graffiti.md index 3d1ecf64f..dfdb2345c 100644 --- a/docs/the_nimbus_book/src/graffiti.md +++ b/docs/the_nimbus_book/src/graffiti.md @@ -1,16 +1,16 @@ # Graffiti -You can use your validator client's graffiti flag to add a personal touch to your proposed blocks (some text of your choice). You will be able to see it using the block explorer. +You can use your node's graffiti flag to make your mark on history and forever engrave some words of your choice into an Ethereum block. You will be able to see it using the block explorer. To do so on **Pyrmont**, run: ``` -./run-pyrmont-beacon-node.sh --graffiti="" +./run-pyrmont-beacon-node.sh --graffiti="" ``` To do so on **Mainnet**, run: ``` -./run-mainnet-beacon-node.sh --graffiti="" +./run-mainnet-beacon-node.sh --graffiti="" ``` diff --git a/docs/the_nimbus_book/src/intro.md b/docs/the_nimbus_book/src/intro.md index 0c3994dfe..2fbecefec 100644 --- a/docs/the_nimbus_book/src/intro.md +++ b/docs/the_nimbus_book/src/intro.md @@ -36,12 +36,12 @@ Although Nimbus will support full and archival nodes, its main implementation wi All our code is open source; we encourage you to keep track of our activity on [GitHub](https://github.com/status-im/nimbus). You can also keep up to date with our progress through the [Nimbus blog](https://our.status.im/tag/nimbus/). -## Get in touch +### Get in touch Need help with anything? Join us on [Status](https://join.status.im/nimbus-general) and [Discord](https://discord.gg/9dWwPnG). -## Disclaimer +### Disclaimer This documentation assumes Nimbus is in its ideal state. The project is still under active development. Please submit a [Github issue](https://github.com/status-im/nimbus-eth2/issues) if you come across a problem.