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

Modernize documentation #6

Open
andnp opened this issue Sep 18, 2021 · 0 comments
Open

Modernize documentation #6

andnp opened this issue Sep 18, 2021 · 0 comments

Comments

@andnp
Copy link
Owner

andnp commented Sep 18, 2021

Classically, documentation has fallen behind the actual implementation. To try to unify code and docs, write documentation as code comments and write a few scripts for generating the markdown from the code comments.

Tie this into the build system and github actions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: To do
Development

No branches or pull requests

1 participant