nimbus-eth2/docs
yslcrypto 8ca2329a20 minor restructure 2021-05-19 16:26:39 +02:00
..
nbc_audit_2020 Consensus object pools [reorg 4/5] (#2374) 2021-03-04 10:13:44 +01:00
the_auditors_handbook openarray -> openArray 2020-11-03 23:23:10 +02:00
the_nimbus_book minor restructure 2021-05-19 16:26:39 +02: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 Consolidate modules by areas [part 1] (#2365) 2021-03-02 11:27:45 +01: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 e2store: add era format (#2382) 2021-03-15 11:31:39 +01:00
logging.md Revisiting log levels (#1788) 2020-10-01 20:56:42 +02:00
rayonism_catalyst_logs.png non-intrusive, novel portions of merge (#2535) 2021-05-04 11:54:19 +00:00
rayonism_merge.md non-intrusive, novel portions of merge (#2535) 2021-05-04 11:54:19 +00:00
rayonism_metamask_network_setup.png non-intrusive, novel portions of merge (#2535) 2021-05-04 11:54:19 +00:00
rayonism_metamask_send_eth.png non-intrusive, novel portions of merge (#2535) 2021-05-04 11:54:19 +00:00
rayonism_metamask_transaction_confirmation.png non-intrusive, novel portions of merge (#2535) 2021-05-04 11:54:19 +00: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