status-im/nimbus-eth2
2
0
Fork 0
mirror of https://github.com/status-im/nimbus-eth2.git synced 2025-02-11 05:56:50 +00:00
Code Issues Projects Releases Wiki Activity
nimbus-eth2/docs
History
sacha df8d744a47
book updates (min viable changes prior to release) (#3283) 
* min viable changes

* make clear keymanager api is not ready for mainnet

* Update docs/the_nimbus_book/src/keymanager-api.md

Co-authored-by: Jacek Sieka <jacek@status.im>

* Update docs/the_nimbus_book/src/keymanager-api.md

Co-authored-by: zah <zahary@gmail.com>

Co-authored-by: Jacek Sieka <jacek@status.im>
Co-authored-by: zah <zahary@gmail.com>
2022-01-14 13:37:21 +01:00
..
nbc_audit_2020
Consensus object pools [reorg 4/5] (#2374)
2021-03-04 10:13:44 +01:00
the_auditors_handbook
update spec references from eth2.0-specs to consensus-specs and to v1.1.0-beta.2 (#2822)
2021-08-26 10:21:52 +02:00
the_nimbus_book
book updates (min viable changes prior to release) (#3283)
2022-01-14 13:37:21 +01:00
amphora_catalyst_run.png
replace obsolete Rayonism interop docs with Amphora interop docs (#2974)
2021-10-11 07:06:13 +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
update from phase0/altair v1.1.6 URLs to v1.1.8 spec URLs (#3238)
2022-01-04 03:57:15 +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 from phase0/altair v1.1.6 URLs to v1.1.8 spec URLs (#3238)
2022-01-04 03:57:15 +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
update era file documentation / impl (#3226)
2022-01-07 11:13:19 +01:00
interop_merge.md
cleanups, partly from kintsugi branch (#3161)
2021-12-05 17:32:41 +00:00
kintsugi_catalyst_logs.png
update kintsugi docs (#3104)
2021-11-15 17:01:27 +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
neth-m2-nimbus.md
implement terminal-total-difficulty-override; keep kintsugi TTDs consistent (#3118)
2021-11-25 10:53:31 +00:00
nimbus_localhost_run.png
update kintsugi docs (#3104)
2021-11-15 17:01:27 +00:00
README.md
bin dist related docs (#2684)
2021-07-05 12:31:25 +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 the top-level dir)
make publish-book