From a0e472040a21ae3f778a86fe2f3a66435055489f Mon Sep 17 00:00:00 2001
From: Lujeni <account@thebault.co>
Date: Mon, 4 Mar 2024 16:32:42 +0100
Subject: [PATCH] docs: explain how to serve mkdocs locally (#2239)

---
 docs/dev-guide/contributing.md | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/docs/dev-guide/contributing.md b/docs/dev-guide/contributing.md
index e30690fe19..2a3752b3b9 100644
--- a/docs/dev-guide/contributing.md
+++ b/docs/dev-guide/contributing.md
@@ -101,7 +101,7 @@ Run setup.py to install
 $ cd py3status
 
 # install you may need to use sudo to have required permissions
-$ python setup.py develop
+$ pip install -e .
 ```
 
 you can now run py3status and any changes to the code you make will be
@@ -120,6 +120,18 @@ available after a reload.
 
 Starting with version 3.26, py3status will only run using python 3.
 
+## Documentation
+
+Documentation pages are located under the docs/ folder.
+
+To run the documentation site locally (useful for previewing changes), use:
+
+```bash
+# you need to install hatch
+# pip install --user hatch
+hatch -e docs mkdocs serve
+```
+
 ## tox
 
 Py3status uses tox for testing. All submissions to the project must pass