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

Update documentation and auto-generate list of commands and descriptions #97

Open
GeckoEidechse opened this issue Dec 28, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@GeckoEidechse
Copy link
Member

There's currently some documentation on Reaper in the docs/ folder but it's heavily outdated.
To prevent it from turning stale again quickly after updating it, we should look into auto-generating it.
There's probably some tool out there that does that by just looking at the functions with decorators or something like that.

Ideally we would use such a tool so that we only have to manually maintain as little documentation for Reaper as possible.

@GeckoEidechse GeckoEidechse mentioned this issue Dec 28, 2024
10 tasks
@GeckoEidechse GeckoEidechse added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Dec 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant