cerc-io/lighthouse
16
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity
aab4a8d2f2
lighthouse/book
History
Michael Sproul aab4a8d2f2 Update docs for mainnet merge release (#3494) 
## Proposed Changes

Update the merge migration docs to encourage updating mainnet configs _now_!

The docs are also updated to recommend _against_ `--suggested-fee-recipient` on the beacon node (https://github.com/sigp/lighthouse/issues/3432).

Additionally the `--help` for the CLI is updated to match with a few small semantic changes:

- `--execution-jwt` is no longer allowed without `--execution-endpoint`. We've ended up without a default for `--execution-endpoint`, so I think that's fine.
- The flags related to the JWT are only allowed if `--execution-jwt` is provided.
2022-08-23 03:50:58 +00:00
..
src Update docs for mainnet merge release (#3494) 2022-08-23 03:50:58 +00:00
.gitignore Add newly created mdbook 2019-09-01 11:31:18 +10:00
book.toml Update HTTP API docs (#1010) 2020-04-16 20:31:43 +10:00
README.md Update HTTP API docs (#1010) 2020-04-16 20:31:43 +10:00

README.md

Lighthouse Book

Contains an mdBook that serves as the primary source of Lighthouse user documentation.

The book is hosted at lighthouse-book.sigmaprime.io

Usage

The mdBook docs are the best source of information for building the book.

Example

  1. Install mdBook: $ cargo install mdbook
  2. Build the book, open it in a browser and build after file changes: $ mdbook serve --open