added contribution instructions

Author: amock

README.md

@@ -23,6 +23,21 @@ mkdocs build --strict
 mkdocs serve --strict
 ```
 
-## Deploy to naturerobots.github.io/mbf_docs
+## Deploy to uos.github.io/rmagine_docs
 
-Anything pushed to branch `deploy` will trigger a Github Action that builds the website and updates [uos.github.io/rmagine_docs](https://uos.github.io/rmagine_docs)
+Anything pushed to branch `deploy` will trigger a Github Action that builds the website and updates [uos.github.io/rmagine_docs](https://uos.github.io/rmagine_docs)
+
+## Contributions
+
+You are welcome to contribute to the docs of [Rmagine](https://github.com/uos/rmagine)! Thorough and clear documentation is essential. You can help us by correcting mistakes, improving content, or adding examples that facilitate user navigation and usage of the project. Please submit any documentation-related issues here. If you're making fixes or adding examples, don’t hesitate to submit a pull request afterward!
+
+### PR workflow
+
+How to contribute to this documentation via pull requests:
+
+1. Fork this repository.
+2. Make changes on your forked repository.
+3. Check locally on your machine if mkdocs is able to compile your changes ([instructions](https://github.com/uos/rmagine_docs)).
+3. Go to Github and click "Pull Request", select this repository's "main" branch as target.
+4. If you added new content, please provide a brief explanation of why you believe it is beneficial for the documentation.
+5. Send PR.

docs/extra/contributions.md

@@ -0,0 +1,11 @@
+# Contributions
+
+We are excited to invite you to contribute to our open source project [Rmagine](https://github.com/uos/rmagine)! Whether you're a seasoned developer, a documentation enthusiast, or someone with fresh ideas, your contributions can make a significant impact.
+
+## How You Can Help:
+
+1. **Code Contributions**: Help us improve the codebase by submitting pull requests. Whether it’s fixing bugs, adding features, or optimizing existing code, every contribution counts!
+
+2. **Documentation**: Clear and comprehensive documentation is crucial. Assist us by correcting errors, enhancing content, or providing examples that make it easier for users to navigate and utilize the project.
+
+3. **Feedback and Suggestions**: Your insights matter! Share your thoughts on how we can improve the project. Opening issues with suggestions or feedback is a great way to get involved.

docs/index.md

@@ -30,4 +30,20 @@ Rmagine allows a robot to simulate sensor data for arbitrary range sensors direc
 - [Data](extra/data)
 - [News](extra/news)
 - [Embree 3](extra/embree3)
+- [Contributions](extra/contributions)
+
+## Contributions
+
+You are welcome to contribute to the docs of [Rmagine](https://github.com/uos/rmagine)! Thorough and clear documentation is essential. You can help us by correcting mistakes, improving content, or adding examples that facilitate user navigation and usage of the project. Please submit any documentation-related issues to the repository https://github.com/uos/rmagine_docs. If you're making fixes or adding examples, don’t hesitate to submit a pull request afterward!
+
+### PR workflow
+
+How to contribute to this documentation via pull requests:
+
+1. Fork the repository: https://github.com/uos/rmagine_docs.
+2. Make changes on your forked repository.
+3. Check locally on your machine if mkdocs is able to compile your changes ([instructions](https://github.com/uos/rmagine_docs)).
+4. Go to Github and click "Pull Request", select this repository's "main" branch as target.
+5. If you added new content, please provide a brief explanation of why you believe it is beneficial for the documentation.
+6. Send PR
 

docs/library/math.md

@@ -261,9 +261,6 @@ int main(int argc, char** argv)
 ```
 
 
-# Math - Advanced
-
-
 ## Changing Precisions
 
 What you have used so far are all types that itself are aliases to specializations of templated math classes:

mkdocs.yml

@@ -48,4 +48,5 @@ nav:
     - Tools: extra/tools.md
     - Data: extra/data.md
     - News: extra/news.md
-    - Embree 3: extra/embree3.md
+    - Embree 3: extra/embree3.md
+    - Contributions: extra/contributions.md