You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
I found https://github.com/microsoft/auto-github-docs-generator. Setting up an LLM to do it doesn't seem ideal though. If I find the time and will I'll update the docs myself. Maybe we just require PRs to update the docs with the change if applicable.
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.
The text was updated successfully, but these errors were encountered: