mod docs readme

bagustris · Mar 14, 2024 · 12625b2 · 12625b2
1 parent 1cfbb09
commit 12625b2
Showing 1 changed file with 7 additions and 4 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -1,14 +1,17 @@
 # Nkululeko documentation  
 
-# How to run documentation locally
+## Documentation URL: [https://nkululeko.readthedocs.io/en/latest/](https://nkululeko.readthedocs.io/en/latest/)
+
+## How to run locally
 ```bash
-# Install requirements
+# Install requirements (from docs directory)
 $ pip install -r requirements.txt
 $ make html
 ```
 
-And then check the built html in `build/html/index.html`
+And then check the built HTML in `build/html/index.html`
 
 ```bash
 $ firefox build/html/index.html
-```
+```
+If found any issues, please report them [here](https://github.com/felixbur/nkululeko/issues).