nimbus-eth2/docs
tersec 28e9568d3c
update docs to use v1.0.1 spec ref URLs (#2368)
2021-03-02 09:32:07 +01:00
..
nbc_audit_2020 Migrate audit tasks from Notion (#2363) 2021-03-01 11:22:35 +01:00
the_auditors_handbook openarray -> openArray 2020-11-03 23:23:10 +02:00
the_nimbus_book book updates (#2345) 2021-02-19 12:17:48 +01:00
README.md docs readme update (#2346) 2021-02-19 15:59:40 +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 update docs to use v1.0.1 spec ref URLs (#2368) 2021-03-02 09:32:07 +01:00
attestation_flow.png [RFC - Doc] State of Nimbus block & attestation flows (#2351) 2021-03-01 11:22:16 +01:00
block_flow.dot [RFC - Doc] State of Nimbus block & attestation flows (#2351) 2021-03-01 11:22:16 +01:00
block_flow.md update docs to use v1.0.1 spec ref URLs (#2368) 2021-03-02 09:32:07 +01:00
block_flow.png [RFC - Doc] State of Nimbus block & attestation flows (#2351) 2021-03-01 11:22:16 +01:00
e2store.md initial e2store file format description (#1355) 2020-09-17 23:23:54 +02:00
logging.md Revisiting log levels (#1788) 2020-10-01 20:56:42 +02:00

README.md

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

Some books also use mdbook-toc for tables of contents.

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

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

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