lighthouse/book
Pawan Dhananjay 7a880dd23c
Update docs for api endpoints (#852)
* Add docs for /beacon endpoints

* Add docs for /network endpoints

* Add docs for /spec endpoint

* Add docs for /advanced endpoint

* Add docs for /validator endpoint

* Minor fixes

* Address reviewer comments
2020-02-14 19:17:12 +11:00
..
src Update docs for api endpoints (#852) 2020-02-14 19:17:12 +11:00
.gitignore Add newly created mdbook 2019-09-01 11:31:18 +10:00
book.toml Make API friendly to block explorers (#702) 2019-12-19 11:45:28 +11:00
README.md Validator on-boarding docs (#656) 2019-12-09 22:42:36 +11:00

Lighthouse Book

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

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

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