mirror of
https://github.com/status-im/nimbus-eth2.git
synced 2025-01-09 22:06:21 +00:00
4adf849d09
* reorganise navigation menus * update light client guide with comparison table * add suggested fee recipient and JWT secrets to the merge guide * add some background info to book readme * add JWT docs also limit toc to make it displayable with substeps.
16 lines
753 B
Markdown
16 lines
753 B
Markdown
The Nimbus Guide is written using markdown and [material for mkdocs](https://squidfunk.github.io/mkdocs-material/).
|
|
|
|
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
|
|
|
|
* [material for mkdocs](https://squidfunk.github.io/mkdocs-material/) - doc generator
|
|
* [divio](https://documentation.divio.com/introduction/) - useful resource diving into the above section structure
|