Contributing

Install the prerequisites

You can use any editor besides VSCode, but that's the one we recommend.

Clone this repository, either with the git CLI, or with VSCode.

git clone https://github.com/Area-53-Robotics/Programming-Guide.git

Install the dependencies.

pip install -r Requirements.txt

Make your changes. We use a tool called MkDocs to generate our documentation from markdown files. We also use the MkDocs Material theme to get some extra formatting options. If this is your first time, have a look through the links below:

The documentation itself is in the docs folder, and settings for MkDocs are in the mkdocs.yml file.

Test your changes.

mkdocs serve

This runs the website locally, at 127.0.0.1:8000.

Once you're happy with the changes you've made, commit and push.

git pull
git add .
git commit -m "Message describing your changes"
git push

This can also be done with VSCode's GUI.