[Feature]: Review 2
Closed this issue · 3 comments
Guidelines
- I agree to follow this project's Contributing Guidelines.
Description
Reviewer @luxaritas requests
Problem
Video documentation is difficult to follow for some users.
Proposed Solution
-
For functionality documentation, add a basic textual guide (with screenshots as appropriate) either to the readme or a separate markdown file in the docs directory with a link from the readme? Doesn't need to be exhaustive.
-
Similarly for automation, add a checklist in a file in the docs directory that describes the testing procedure? The demo video is great, but doesn't provide a clear list of steps of things that should be checked to know the software is behaving appropriately.
Alternatives Considered
Video documentation.
See comment: openjournals/joss-reviews#5136 (comment)
We do have some manual testing documentation already which is also cross-referenced in the readme: https://github.com/code4sac/trash-ai/tree/production/frontend/__tests__
I will add the checklist suggested.