The Student Robotics public documentation.
For ease of setup, a Docker container is provided. Install Docker and docker-compose, then run docker compose up.
Once setup, the site will be accessible on http://localhost:4000/docs/
-
Install Bundler (2.3 or above) and Rake
$ gem install bundler rake
-
Start the app in development mode
$ rake dev
When you've made a change, either push it to a forked repository, or to a feature branch, and raise a pull request.
The docs navigation sidebar is generated from _data/sidebar_tree.yaml as part
of the build process. This file is manually updated so that we can
explicitly control which files are included, in what order as well as adjust the
page titles.