nimbus-eth2/docs
Etan Kissling 9fc870777c
remove Bellatrix EL syncing support from light client (#6352)
Bellatrix light client data does not contain the EL block hash, so we
had to follow blocks gossip to learn the EL `block_hash` of such blocks.
Now that Bellatrix is obsolete, we can simplify EL syncing logic under
light client scenarios. Bellatrix light client data can still be used
to advance the light client sync itself, but will no longer result in
`engine_forkchoiceUpdated` calls until the sync reaches Capella. This
also frees up some memory as we no longer have to retain blocks.
2024-06-14 01:23:17 +00:00
..
nbc_audit_2020 Consensus object pools [reorg 4/5] (#2374) 2021-03-04 10:13:44 +01:00
the_auditors_handbook rename reference of `RangeError` to `RangeDefect` (#5902) 2024-02-17 20:29:06 +01:00
the_nimbus_book remove Bellatrix EL syncing support from light client (#6352) 2024-06-14 01:23:17 +00:00
.gitignore Migrate docs to mkdocs (#3900) 2022-07-22 21:47:24 +02:00
Makefile Version 23.3.0 2023-03-11 02:51:44 +02:00
README.md update mdbook versions 2023-11-10 08:40:04 +01:00
attestation_flow.dot [RFC - Doc] State of Nimbus block & attestation flows (#2351) 2021-03-01 11:22:16 +01:00
attestation_flow.md some consensus spec v1.4.0 spec URL updates (#6208) 2024-04-17 05:51:16 +02:00
attestation_flow.png [RFC - Doc] State of Nimbus block & attestation flows (#2351) 2021-03-01 11:22:16 +01:00
block_flow.dot Backward sync support for SyncManager. (#3131) 2021-12-08 22:15:29 +01:00
block_flow.md some consensus spec v1.4.0 spec URL updates (#6208) 2024-04-17 05:51:16 +02:00
block_flow.png [RFC - Doc] State of Nimbus block & attestation flows (#2351) 2021-03-01 11:22:16 +01:00
cpu_features.md docs: fix typos (#5689) 2024-01-03 12:48:08 +00:00
e2store.md chore: remove repetitive words (#6219) 2024-04-19 11:31:15 +00:00
logging.md Revisiting log levels (#1788) 2020-10-01 20:56:42 +02:00
requirements.in Migrate docs to mkdocs (#3900) 2022-07-22 21:47:24 +02:00
requirements.txt Bump jinja2 from 3.1.3 to 3.1.4 in /docs (#6269) 2024-05-06 22:35:57 +00:00

README.md

Documentation

material for mkdocs

The Nimbus guide is generated using Material for mkdocs, and installed using a python VENV (see Makefile).

mdbook

Some books in this folder were produced using mdBook - see installation guide.

# Install or update tooling (make sure you add "~/.cargo/bin" to PATH):
cargo install mdbook --version 0.4.35
cargo install mdbook-toc --version 0.14.1
cargo install mdbook-open-on-gh --version 2.4.1
cargo install mdbook-admonish --version 1.13.1

# Work on the book locally - open "http://localhost:4000" for live version
cd docs/the_auditors_handbook
mdbook serve -p 4000

# Create a local copy of the book
make book

# Publish book using makefile (in the top-level dir)
make publish-book