santa icon indicating copy to clipboard operation
santa copied to clipboard

Documentation Overhaul

Open russellhancox opened this issue 2 years ago • 5 comments

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.

russellhancox avatar Aug 18 '21 19:08 russellhancox

cc @pmarkowsky

russellhancox avatar Aug 18 '21 19:08 russellhancox

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.

pmarkowsky avatar Aug 19 '21 15:08 pmarkowsky

  • [ ] Using ESF vs. the KEXT.

pmarkowsky avatar Aug 19 '21 15:08 pmarkowsky

We should also document the sync server protocol.

pmarkowsky avatar Sep 02 '21 18:09 pmarkowsky

  • [ ] 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.

russellhancox avatar Mar 07 '22 16:03 russellhancox