Source code for documentation written by MRS members for MRS members. Documentation is hosted using MKDocs with the Material theme
This documentation is not meant to be a guide that covers everything under the sky and should not attempt to cover information for PX4, ardupilot etc that is already available on their respective documentation sites.
What this documentation site should be is a way to point people in the right direction and help less experienced members understand high level documentation available.
Download MKDocs and Material theme with
python3 -m pip install --upgrade mkdocs mkdocs-material
Clone the master branch
Then from inside the repo folder, run mkdocs serve to serve locally at 127.0.0.1:8000. Edits to .md files will show up in realtime
Pages are written in markdown (.md) and are found in the docs directory.
Markdown formatting guide can be found here.
MKDocs Material theme also supports extra extra extensions to make documentation easier to read or just nicer to look at. Information on this can be found on the MKDocs Material page.
If you are adding pages or changing the organisation of the documentation site, update mkdocs.yml to reflect the new site organisation. Read the documentation here to see how to update mkdocs.yml
Once you are satisfied with your changes, commit them to the DEV branch (NOT THE MASTER BRANCH) and EXCO Logs will review the commit before merging it