User manual and structured documentation - Githubissues

ocurrent / current-bench

Experimental benchmarking infrastructure using OCurrent pipelines

Apache License 2.0

33 stars 17 forks source link

User manual and structured documentation #491

Closed tmattio closed 6 months ago

tmattio commented 7 months ago

Opening on behalf of @punchagan who's been writing most of the new user manual.

Create structure documentation for the project in doc/.
Add a user manual in doc/user_manual.md.
Add a JSON specification in doc/json_spec.md.
Move a hardware tuning guide to doc/hardware_tuning.md.
Rewrite README to point to the documentation.
Stop advertising for enrolment of community projects in the README.

TODO

[x] Create an example of a project setup in doc/demo.
[x] Add screenshots in the user manual.

punchagan commented 6 months ago

Added screenshots and link to demo project, and made some minor fixes to the text.