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 sorely out of date #86

Open
KasperFyhn opened this issue Nov 27, 2024 · 0 comments
Open

Documentation sorely out of date #86

KasperFyhn opened this issue Nov 27, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@KasperFyhn
Copy link
Contributor

This project has been in the hands of many developers over time, and it shows.

The documentation is mostly on the individual components at the moment, some of which are not being used anymore, at least not in the way they are now.

The full pipeline, with run.py, configuration etc. also lacks documention. There is something under FAQ, but assuming that it should be the main entry for any user or developer, it should be one of the first things to see in a readme and the docs.

@KasperFyhn KasperFyhn added the documentation Improvements or additions to documentation label Nov 27, 2024
@KasperFyhn KasperFyhn self-assigned this Nov 27, 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
Projects
None yet
Development

No branches or pull requests

1 participant