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.

Sign up for GitHub

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

Jump to bottom

Improve Documentation #171

Open

3 of 8 tasks

lupeterm opened this issue Jan 11, 2024 · 1 comment

Labels

Collaborator

lupeterm commented Jan 11, 2024 •

edited

Loading

Currently missing things from the documentation:

Postprocessing steps (this is also missing in the README)
dark mode (please)
fix link to micro benchmarks repository #174
obr archive and obr apply are missing entirely, while obr operations exists, but is not supported anymore.

Things we [c | sh]ould improve:

showing the entire workflow, maybe add graphics
maybe more interactivity, as in, more fine-grained examples
option to switch between branches/versions within the documentation
The CLI reference docpage needs more depth

The text was updated successfully, but these errors were encountered:

lupeterm added the documentation label

Collaborator Author

lupeterm commented Jan 11, 2024

the list above is, of course, not exhaustive. Will add more things as they come up.

lupeterm changed the title ~~Imrove Documentation~~ Improve Documentation

greole linked a pull request

that will close this issue

Improve Readme and Documentation #180

Merged

4 tasks

greole removed a link to a pull request

Improve Readme and Documentation #180

Merged

4 tasks

greole mentioned this issue

Improve Readme and Documentation #180

Merged

4 tasks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment