Build user "recipe" guide for Sidre
Open
Nobody has claimed this yet.
Reviewed
Sidre
- Dominant language
- C++
- Stars
- 196
- Forks
- 34
- Avg merge
- 4d 1h
- Merged PRs (30d)
- 11
Description
To explain to app users how to implement various usage patterns in their codes, build up a recipe guide in the user docs. It may be a good idea to mine some apps first, to see what folks are doing.
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 by reviewing the Sidre user documentation and mining applications for the usage patterns the guide should cover. Organize those patterns into practical recipes for app users, and consider the scope complete when the user docs contain a coherent guide covering the selected patterns.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100