nimbus-eth2/docs
tersec ad8e682f76
remove redundant justification and finalization tests (#4412)
2022-12-09 22:45:48 +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 unify bn/vc doppelganger detection (#4398) 2022-12-09 17:05:55 +01:00
.gitignore Migrate docs to mkdocs (#3900) 2022-07-22 21:47:24 +02:00
Makefile Migrate docs to mkdocs (#3900) 2022-07-22 21:47:24 +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 EIP4844 tweaks to pass SSZ consensus object tests (#4390) 2022-12-05 21:36:53 +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 ref URL update to v1.3.0-alpha.1 (#4354) 2022-11-24 19:07:02 +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 remove built-in Ropsten support (#4280) 2022-12-05 11:15:00 +02:00
eth2-finalization.png remove redundant justification and finalization tests (#4412) 2022-12-09 22:45:48 +00:00
kiln_geth_local_testnet.md remove obsolete merge test vector test bash script (#4135) 2022-09-16 22:49:39 +02:00
kiln_geth_logs.png update docs for geth/kiln 2022-02-11 20:06:06 +00:00
logging.md Revisiting log levels (#1788) 2020-10-01 20:56:42 +02:00
nimbus_localhost_run.png update docs for geth/kiln 2022-02-11 20:06:06 +00:00
requirements.in Migrate docs to mkdocs (#3900) 2022-07-22 21:47:24 +02:00
requirements.txt Migrate docs to mkdocs (#3900) 2022-07-22 21:47:24 +02: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