mirror of https://github.com/sigp/lighthouse.git synced 2026-03-03 00:31:50 +00:00

Files

Jimmy Chen 8880675eda Add make lint to development environment section in Book (#4866 )

## Issue Addressed

We run `clippy` as part of our CI, so it would help new devs if we add the `make lint` command to the dev setup section in the Lighthouse book.

2023-10-20 06:23:29 +00:00

src

Add make lint to development environment section in Book (#4866 )

2023-10-20 06:23:29 +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

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