nimbus-eth2/docs
zah 2ae909d9b9
Documentation improvements (#4794)
2023-04-28 00:30:58 +03:00
..
nbc_audit_2020 Consensus object pools [reorg 4/5] (#2374) 2021-03-04 10:13:44 +01:00
the_auditors_handbook enable `styleCheck:usages` (#3573) 2022-04-08 16:22:49 +00:00
the_nimbus_book Documentation improvements (#4794) 2023-04-28 00:30:58 +03: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 book edits (#3955) 2022-08-13 20:17:20 +02:00
attestation_flow.dot [RFC - Doc] State of Nimbus block & attestation flows (#2351) 2021-03-01 11:22:16 +01:00
attestation_flow.md automatic update of v1.3.0-rc.5 consensus spec URLs to v1.3.0 (#4848) 2023-04-21 18:52:43 +00: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 automatic update of v1.3.0-rc.5 consensus spec URLs to v1.3.0 (#4848) 2023-04-21 18:52:43 +00:00
block_flow.png [RFC - Doc] State of Nimbus block & attestation flows (#2351) 2021-03-01 11:22:16 +01:00
cpu_features.md Cpu architecture optimization documentation (#2483) 2021-04-08 15:48:43 +02:00
e2store.md era: Capella+ support (fixes #4752) (#4853) 2023-04-24 15:26:28 +02:00
eth2-finalization.png remove redundant justification and finalization tests (#4412) 2022-12-09 22:45:48 +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 manual rebase of Bump wheel from 0.37.1 to 0.38.1 in /docs #4446 (#4456) 2023-01-03 18:02:05 +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.18
cargo install mdbook-toc --version 0.8.0
cargo install mdbook-open-on-gh --version 2.1.0
cargo install mdbook-admonish --version 1.7.0

# Work on the book locally - open "http://localhost:4000" for live version
cd docs/the_nimbus_book
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