Add Use Case pages to RTD, include binary file usage
Open
Nobody has claimed this yet.
documentation
- Dominant language
- C
- Stars
- 200
- Forks
- 85
- Avg merge
- 3d 21h
- Merged PRs (30d)
- 2
Description
We should put detailed use cases / workflows on our RTD (currently we have some use cases documented in the wiki.
Particularly, we should highlight the use of the binary file to feed into subsequent tool use.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the existing use cases in the project wiki and identify the workflows that should be brought into the Read the Docs documentation. Add detailed use-case pages, including how the binary file feeds subsequent tool use; the work is done when these workflows are documented on RTD.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100