docs: add instructions for building docs locally

UpstreamData · Jan 17, 2025 · 88b4d2c · 88b4d2c
1 parent 5842ef3
commit 88b4d2c
Showing 1 changed file with 7 additions and 0 deletions.
diff --git 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