readme

nuvolaris · Feb 19, 2024 · 6617997 · 6617997
1 parent 4de482b
commit 6617997
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -3,3 +3,16 @@
 Sources for [Nuvolaris Community Documentation](https://nuvolaris.github.io).
 
 
+## How to edit documentation
+
+Setup 
+
+1. git clone [email protected]:nuvolaris/nuvolaris.github.com --recurse-submodules
+2. cd nuvolaris.github.com/nuvolaris-documentat/3.1.0
+3. git checkout origin/3.1.0 -B 3.1.0
+4. cd ../..
+
+Now you edit nuvolaris-documentat/3.1.0/modules
+
+- task preview to see in localhost:8000
+- task publish to publish documentation