status-im/nimbus-eth2
2
0
Fork 0
mirror of https://github.com/status-im/nimbus-eth2.git synced 2025-02-12 22:46:59 +00:00
Code Issues Projects Releases Wiki Activity
nimbus-eth2/docs/the_nimbus_book
History
Etan Kissling 2823be7306
periodically log LC sync progress (#4339) 
Adds a "Slot start" log to the LC that behaves similar to BN to inform
the user that the light client is doing something, and to indicate the
latest view of the network (finalized / optimistic).
2022-11-22 16:39:03 +01:00
..
src
periodically log LC sync progress (#4339)
2022-11-22 16:39:03 +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