status-im/nimbus-eth2
2
0
Fork 0
mirror of https://github.com/status-im/nimbus-eth2.git synced 2025-02-08 20:54:33 +00:00
Code Issues Projects Releases Wiki Activity
nimbus-eth2/docs/the_nimbus_book
History
Jacek Sieka 1b90f65f7b
doc updates (#4314) 
* optimise index / landing page real estate, add feature list
* fee recipient in quickstart
* recommend http over websockets  (fewer command line options needed)
* simplify PBS, fee recipient docs
* add VC role / sentry node docs (#4140)
* Update docs/the_nimbus_book/src/rest-api.md

Co-authored-by: tersec <tersec@users.noreply.github.com>
2022-11-13 07:59:55 +01:00
..
src
doc updates (#4314)
2022-11-13 07:59:55 +01: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
mkdocs.yml
doc updates (#4314)
2022-11-13 07:59:55 +01:00
README.md
book edits (#3955)
2022-08-13 20:17:20 +02: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