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

Docs: merge Appendix B and Appendix C #146

Open
jjohannes opened this issue Jun 4, 2024 · 0 comments
Open

Docs: merge Appendix B and Appendix C #146

jjohannes opened this issue Jun 4, 2024 · 0 comments
Labels
documentation Improve documentation

Comments

@jjohannes
Copy link
Member

  • Appendix B is generated based on the CapabilityDefinition enum and contains all capabilities (and looks a bit crappy)
  • Appendix C is manually maintained and contains only logging capabilities (and looks nicer and has descriptions)

The idea is to pimp the generator for B to generate the table format that we currently have in C. The CapabilityDefinition enum should get an additional (optional) field for the description. This way, the descriptions can move into the code and can be picked up by the generator. Appendix C can then be removed.

@jjohannes jjohannes added the documentation Improve documentation label Jun 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improve documentation
Projects
None yet
Development

No branches or pull requests

1 participant