Files
lighthouse/book
chonghe 5022398715 Revise Siren documentation (#6553)
* revise Siren doc

* Fix broken links

* Fix broken links

* broken links

* mdlint

* mdlint

* mdlint again

* Merge branch 'unstable' into book-siren

* test whether I have the required privs :-)

* revise

* some minor siren related changes for the book

* updates re: `--net=host`

* lint

* Minor revision

* Add note

* mdlint

* Merge branch 'unstable' into book-siren

* Merge branch 'unstable' into book-siren

* Merge remote-tracking branch 'origin/unstable' into book-siren

* Fix spellcheck

* Capital letters SSL
2024-12-19 05:46:10 +00:00
..
2024-12-19 05:46:10 +00:00
2019-09-01 11:31:18 +10:00
2024-05-24 02:45:19 +00:00
2020-04-16 20:31:43 +10:00
2020-04-16 20:31:43 +10: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

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