Satellite Documentation
I would like to propose the following structure for the documentation of individual satellite implementations:
- Each satellite is documented by a markdown file named
README.md
, detailing all necessary things (how to deply, what it does, how it works, what hardware it controls, what limitations it has, but most importanyly which config parameters it reads/expects...) - This markdown file is placed next to the satellite implementation in a separate folder
- Suggestion would be e.g.
cxx/satellites/caribou/README.md
orpython/satellites/redpitaya/README.md
- These individual
README
files are collected by the CI when building the website, and assembled in a page called "Satellites" (to appear next to "User guide" and "developer guide") with a list of all available implementations
In my opinion this is advantageous to having the documentation centrally in e.g. docs/satellites
because it is much easier to see that the documentation was updated together with the code, it is much quicker to see that a MR does not alter central components but just one satellite implementation.
Opinions?