add instructions to live reload docs

2024-04-12 15:32:51 +02:00 · 2024-04-12 15:32:51 +02:00 · 60f2bf54c3
parent 1e08a454fb
commit 60f2bf54c3
1 changed files with 21 additions and 0 deletions
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@ -0,0 +1,21 @@
+# Contributing to cLAN
+
+## Live-reloading documentation
+
+Enter the `docs` directory:
+
+```shell-session
+cd docs
+```
+
+Enter the development shell or enable `direnv`:
+
+```shell-session
+direnv allow
+```
+
+Run a local server:
+
+```shell-session
+mkdocs serve
+```