Improve Documentation - Githubissues

exasim-project / OBR

A runner for OpenFOAM benchmarks

BSD 3-Clause "New" or "Revised" License

3 stars 1 forks source link

Improve Documentation #171

Open lupeterm opened 8 months ago

lupeterm commented 8 months ago

Currently missing things from the documentation:

[x] Postprocessing steps (this is also missing in the README)
[x] dark mode (please)
[x] #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

lupeterm commented 8 months ago

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