This documentation is built into a website using Quartz, so to build the site look at their docs.
When editing the docs, it’s best to follow a few simple guidelines:
- Don’t create a new file if you don’t have to
- Don’t create a new folder if you don’t have to
- KISS (Keep It Simple, Stupid)
The first two guidelines are in an effort to prevent bloat. Because of the small overlap between project timelines, we want to keep onboarding smooth, and minimizing the number of files to keep track of helps with that. This small overlap also means people probably won’t be cleaning this site up often (if at all), so we need to try to prevent messes before we make them.
The third is in an effort to keep these docs readable. It’s tough to remember just how little you knew when you joined this research group, and even tougher to write documentation with that in mind. Remember that your reader has probably never heard of ROS (or most other softwares we use), maybe has written come C/C++ code, and hasn’t read as many papers on this stuff as you have.