cerc-io/lighthouse
15
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity
5121d655f7
lighthouse/book
History
joao aa592853df
Improvements and Fixes in Documentation, Including Corrected Command Usage (#4998) 
* Fix typo: change 'periodical' to 'periodic' in progress updates description

* Fix wrong command in Usage section

* fix typo in Development Environment section

* Fix typo: change 'Explictly' to 'Explicitly'

* Fix typos in Lighthouse UI and Contributing sections

* Fix typo: replace 'confirms' with 'conforms' in Beacon Node API description

* fix minor typographical error: change 'advice' to 'advise' in SIGILL warning message

* Fix spelling error in Detailed Guide section

* Revert "Fix typo: change 'Explictly' to 'Explicitly'"

This reverts commit 6b0781682b4f9d129d9af48d428353f596b8b852.

* Revert "fix minor typographical error: change 'advice' to 'advise' in SIGILL warning message"

This reverts commit a4904a0afd2d531caf4585e1f0726a6dd65081ea.

* compiled

* Revert "compiled"

This reverts commit 425a553bd93af93340858050cc45041ae86b3733.

* Revert "Revert "compiled""

This reverts commit b1f871cb1bd41822f4c7bd696f77ba38cdd32f9d.

* Empty commit to trigger CI.
2024-03-20 06:44:44 +00:00
..
src Improvements and Fixes in Documentation, Including Corrected Command Usage (#4998) 2024-03-20 06:44:44 +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