santa
santa copied to clipboard
Documentation Overhaul
The docs are, in many ways, out-of-date and could be much clearer. We need to document how to configure many things, better docs on deployment, better docs on how to build the project, etc.
We could also do with tidying up the old ReadTheDocs config.
cc @pmarkowsky
Just listing things off the top of my head that we should add to docs:
- [ ] How to setup your own environment (bootstrapping with your own dev certs).
- [ ] State machines for rules (e.g. what takes precedence certificate vs. binary rules.)
- [ ] Setting up an easy dev cycle with configs.
- [ ] Updating coverage, etc.
- [ ] Using ESF vs. the KEXT.
We should also document the sync server protocol.
- [ ] Better documentation of configuration options instead of a simple table with little explanation. Ideally we'd have some automation of these docs from the headers.