Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Overhaul #585

Open
russellhancox opened this issue Aug 18, 2021 · 5 comments
Open

Documentation Overhaul #585

russellhancox opened this issue Aug 18, 2021 · 5 comments
Labels
cleanup docs Documentation-related issues enhancement

Comments

@russellhancox
Copy link
Collaborator

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
Copy link
Collaborator Author

cc @pmarkowsky

@pmarkowsky
Copy link
Contributor

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
Copy link
Contributor

  • Using ESF vs. the KEXT.

@pmarkowsky
Copy link
Contributor

We should also document the sync server protocol.

@russellhancox russellhancox added the docs Documentation-related issues label Oct 12, 2021
@russellhancox
Copy link
Collaborator Author

russellhancox commented Mar 7, 2022

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cleanup docs Documentation-related issues enhancement
Projects
None yet
Development

No branches or pull requests

3 participants