status-im
/
nimbus-eth2
mirror of https://github.com/status-im/nimbus-eth2.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
nimbus-eth2/docs/the_nimbus_book
History
zah 0be57eec6e
Don't package the nimbus_validator_client in the nimbus-eth2 docker images; Document the new dedicated image (#4441) 		2022-12-20 23:32:31 +02:00
..
src Don't package the nimbus_validator_client in the nimbus-eth2 docker images; Document the new dedicated image (#4441) 2022-12-20 23:32:31 +02:00
.gitignore
…
CNAME
…
README.md book edits (#3955) 2022-08-13 20:17:20 +02:00
mkdocs.yml unify bn/vc doppelganger detection (#4398) 2022-12-09 17:05:55 +01:00

README.md

The Nimbus Guide is written using markdown and material for mkdocs.

See the Makefile for setup.

The guide is divided into several sections - broadly:

  • Guides - walk-throughs that allow the user to get started with a specific area of the client
  • How-to:s - short pages that show the user how to solve a specific problem or perform a specific task
  • Reference - pages describing how specific parts of Nimbus work, reference-style
  • "Other" - explanations of concepts, background etc.

Resources