Updating The Docs

This guide explains how to update the broncobots-docs project.

Prerequisites

• Create a GitHub account.
• Optional: Be a member of the Broncobots organization.
• Optional: Python and / or Docker, along with an IDE like VSCode.

Prepare for committing changes.

• If you are a member of the Broncobots organization, then create a branch in this repository for the relevant change.
• If you are not a member of the Broncobots organization, then create a fork.
• Clone the repository or be comfortable making changes directly on GitHub.

Adding Docs

1. Copy the template.md from the root directory and paste it to the appropriate directory in this project.
   • Create a new directory if needed.
2. Replace generic content from the template with the new specific information.
3. Update the mkdocs.yml file in the root directory with structure for the new content.

Updating Docs

1. Edit the relevant files directly.

Removing Docs

1. Delete the relevant files.
2. Remove references to the deleted files in the mkdocs.yml file in the root directory.

Submitting Changes For Review

1. Commit your changes early and often.
2. Open a Pull Request to merge your changes into the master branch.
   • From a branch.
   • From a fork.

References

• MKDocs: writing and structuring docs
• Markdown cheat sheet: formatting docs