nimbus-eth2/docs
Jacek Sieka f70ff38b53
enable `styleCheck:usages` (#3573)
Some upstream repos still need fixes, but this gets us close enough that
style hints can be enabled by default.

In general, "canonical" spellings are preferred even if they violate
nep-1 - this applies in particular to spec-related stuff like
`genesis_validators_root` which appears throughout the codebase.
2022-04-08 16:22:49 +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 Revert "Polish, remove beta warning for validator monitor (#3531)" (#3578) 2022-04-08 15:05:17 +00:00
README.md bin dist related docs (#2684) 2021-07-05 12:31:25 +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 update unchanged specs/phase0/p2p-interface.md URL references from v1.1.9 to v1.1.10 (#3510) 2022-03-16 10:40:35 +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 update unchanged specs/phase0/p2p-interface.md URL references from v1.1.9 to v1.1.10 (#3510) 2022-03-16 10:40:35 +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: load blocks and states (#3394) 2022-03-23 09:58:17 +01:00
kiln_geth_local_testnet.md kiln v2 documentation and testing (#3446) 2022-03-05 16:40:58 +02:00
kiln_geth_logs.png update docs for geth/kiln 2022-02-11 20:06:06 +00:00
kintsugi_nethermind_logs.png document how to run merge local testnet with Nethermind (#3110) 2021-11-17 20:45:39 +01:00
logging.md Revisiting log levels (#1788) 2020-10-01 20:56:42 +02:00
mev_boost.md add mev-boost RPC test, with docs (#3430) 2022-02-24 14:38:31 +01:00
neth-m2-nimbus.md add mev-boost RPC test, with docs (#3430) 2022-02-24 14:38:31 +01:00
nimbus_localhost_run.png update docs for geth/kiln 2022-02-11 20:06:06 +00:00
running_nimbus_on_kiln.md running Nimbus on Kiln 2022-03-13 19:39:11 +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 the top-level dir)
make publish-book