The runbook aims to be a single source for all Student Robotics internal documentation. This includes information for the Competition Team and Kit Team, as well as other activities.
To run this project locally, you'll need:
- Python (
>=3.6, <3.12) pip
It's recommended to use a virtual environment:
python -m venv env
env\Scripts\activate.bat # on windows
source env/bin/activate # on macOS / Linux
Then, install dependencies:
pip install -r requirements.txt
mkdocs serve
This will launch a server on http://localhost:8000. Content in the server will live-reload as changes are made. If large refactors of the site structure are made, it's advisable to stop the server, make the changes, then restart it.
mkdocs build
This will build the site once, and place it in site/ in the root of the project. This may be useful to see which files are rendered, and how exactly to access them.
This project uses CSpell for spell checking. Plugins are
available for a variety of editors and a command line runner is available
through npm:
npm install
npm run spell-check
Words that CSpell is unaware of can be added to the .spelling file.
This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
