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
Miran cabb2779b4
Make the validating guide self-contained (#5076) 
* make the validating guide self-contained

Instead of having links to the three separate how-to guides,
now everything is under one umbrella.

* fix all now-broken links

* Apply suggestions from code review

Co-authored-by: tersec <tersec@users.noreply.github.com>

* address review comments

---------

Co-authored-by: tersec <tersec@users.noreply.github.com>
 		2023-06-20 14:38:10 +00:00
..
src Make the validating guide self-contained (#5076) 2023-06-20 14:38:10 +00:00
.gitignore Migrate docs to mkdocs (#3900) 2022-07-22 21:47:24 +02:00
CNAME add cname file to docs to fix domain issues (#2260) 2021-01-22 17:57:55 +01:00
README.md book edits (#3955) 2022-08-13 20:17:20 +02:00
mkdocs.yml Make the validating guide self-contained (#5076) 2023-06-20 14:38:10 +00: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