Add article about updating documentation

docs/index.md

@@ -1,6 +1,7 @@
 # Antenna documentation
 
-! DISCLAIMER - This documentation is a work in progress !
+!!! note
 
-The contents are continuously update - That being said, if you notice problems
-or sections not up to date, please open an issue [here](https://github.com/RolnickLab/antenna/issues).
+    This documentation is a work in progress!
+
+If you notice problems or sections not up to date, please open an issue [here](https://github.com/RolnickLab/antenna-docs). For contributions, checkout [this](sections/dev-guide/update-documentation) article.

docs/sections/dev-guide/update-documentation.md

@@ -0,0 +1,23 @@
+# Update documentation
+
+The documentation lives in the public GitHub repository [antenna-docs](https://github.com/RolnickLab/antenna-docs/). To suggest updates, you first need a [GitHub account](https://github.com/signup). Once logged in, you can start open pull requests to add or update articles. All contributions are much appreciated!
+
+Articles are written in [Markdown](https://www.mkdocs.org/user-guide/writing-your-docs/#writing-with-markdown) format. There are currently 2 main categories of articles. The _User Guide_ includes articles for Antenna users. The _Developer Guide_ includes articles for Antenna contributors.
+
+!!! tip "Tip"
+
+    Do you need a quick reference to the Markdown syntax? Checkout this [Markdown Cheat Sheet](https://www.markdownguide.org/cheat-sheet/)!
+
+## Add a new article
+
+1. Go to the folder [user-guide](https://github.com/RolnickLab/antenna-docs/tree/main/docs/sections/user-guide) or [dev-guide](https://github.com/RolnickLab/antenna-docs/tree/main/docs/sections/dev-guide)
+2. Add a new file to the folder. Make sure it uses the Markdown extension, for example `new-article.md`.
+3. Write the article
+4. To make the new article show up in the sidebar, add a row to [mkdocs.yml](https://github.com/RolnickLab/antenna-docs/blob/main/mkdocs.yml)
+5. Open a pull request with the changes
+
+## Update an existing article
+
+1. Go to the folder [user-guide](https://github.com/RolnickLab/antenna-docs/tree/main/docs/sections/user-guide) or [dev-guide](https://github.com/RolnickLab/antenna-docs/tree/main/docs/sections/dev-guide)
+2. Locate the article and update it
+3. Open a pull request with the changes

docs/sections/user-guide/processing-data.md

@@ -1,6 +1,6 @@
 # Processing data
 
-!!! note
+!!! danger "Warning"
 
     Batch processing is currently in development and problems are likely to occur. If you need data processed, we recommend to reach out to the team for support. Thank you for your patience!
 

mkdocs.yml

@@ -1,7 +1,7 @@
-site_name: Antenna Platform Documentation
+site_name: Antenna documentation
 
 nav:
-  - User Guide:
+  - User guide:
       - sections/user-guide/account-creation.md
       - sections/user-guide/project-creation.md
       - sections/user-guide/uploading-data.md
@@ -11,8 +11,9 @@ nav:
       - sections/user-guide/validating-data.md
       - sections/user-guide/visualizing-data.md
       - sections/user-guide/exporting-data.md
-  - Developer Guide:
+  - Developer guide:
       - sections/dev-guide/developer-guide.md
+      - sections/dev-guide/update-documentation.md
 
 theme: readthedocs