-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1aad165
commit e91c156
Showing
1 changed file
with
24 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# Greenlight docs | ||
|
||
The docs are hosted on https://blockstream.github.io/greenlight/ | ||
|
||
## Contributing to the documentation | ||
|
||
You must have a working installation of `python` and `poetry` to contribute to the docs. | ||
|
||
To install dependencies make sure you are at the root of the repository | ||
|
||
``` | ||
poetry install --with-only docs | ||
``` | ||
|
||
To build the docs | ||
|
||
``` | ||
cd docs; mkdocs build | ||
``` | ||
|
||
To serve the docs locally | ||
``` | ||
cd docs; mkdocs serve | ||
``` |