docs: add instructions for building docs locally

2025-01-16 05:16:24 -05:00
parent 5842ef3d97
commit 88b4d2cac3
1 changed files with 7 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -50,6 +50,13 @@ poetry install --with dev
 pre-commit install
 ```

+##### Building Documentation Locally
+```
+poetry install --with docs
+python docs/generate_miners.py
+poetry run mkdocs serve
+```
+
 ---
 ## Getting started