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
Etan Kissling 2324136552
add `LightClientHeader` wrapper (#4481) 
The light client data structures were changed to accommodate additional
fields in future forks (e.g., to also hold execution data).

There is a minor change to the JSON serialization, where the `header`
properties are now nested inside a `LightClientHeader`.
The SSZ serialization remains compatible.

See https://github.com/ethereum/consensus-specs/pull/3190
and https://github.com/ethereum/beacon-APIs/pull/287
 		2023-01-13 16:46:35 +01:00
..
src add `LightClientHeader` wrapper (#4481) 2023-01-13 16:46:35 +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
README.md book edits (#3955) 2022-08-13 20:17:20 +02:00
mkdocs.yml History pruning (fixes #4419) (#4445) 2023-01-07 10:02:15 +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