nimbus-eth2/docs
tersec 85e1976ac3
automated consensus spec URL updating to v1.4.0-beta.1 (#5280)
2023-08-09 03:58:47 +00: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 automated consensus spec URL updating to v1.4.0-beta.1 (#5280) 2023-08-09 03:58:47 +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 required mdbook versions (#5125) 2023-06-26 16:04:01 +00:00
attestation_flow.dot [RFC - Doc] State of Nimbus block & attestation flows (#2351) 2021-03-01 11:22:16 +01:00
attestation_flow.md automated consensus spec URL updating to v1.4.0-beta.1 (#5280) 2023-08-09 03:58:47 +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 automated consensus spec URL updating to v1.4.0-beta.1 (#5280) 2023-08-09 03:58:47 +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 Merkle is someone's name (#5265) 2023-08-07 10:06:47 +00: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 Bump pygments from 2.12.0 to 2.15.0 in /docs (#5206) 2023-07-20 14:25:45 +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.28
cargo install mdbook-toc --version 0.8.0
cargo install mdbook-open-on-gh --version 2.3.3
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