Mesh Navigation Documentation

Documentation

This documentation is under construction. It will contain both explanations for more applied users and for developers.

Table of Contents

This documentation cosists of several examples, guides and conceptual explanations to give users a more thourough understanding of mesh_navigation.

Getting Started

• Overview
• Installation
• Run

Documentation

• Theory
• Tutorials
• Library
• Guides

Contributions

You are welcome to contribute to the docs of mesh_navigation! 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 mesh_navigation_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: mesh_navigation_docs.
2. Make changes on your forked repository.
3. Check locally on your machine if mkdocs is able to compile your changes (instructions).
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