Add wiki and/or examples directory to source
Open
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 2.3k
- Forks
- 293
- PR merge metrics
- No merged PRs in 30d
Description
There are a couple of things which are not that easy to figure from plain API docs. A wiki and/or an "examples" directory in the source would help a lot with that. Could also help to have a way to see how to do something "the proper way".
Contributor guide
No contributing guide indexed for this repository
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 existing API documentation and the source repository layout to identify gaps in practical guidance. Define whether a wiki, an examples directory, or both best address those gaps, then document proper usage patterns and verify that the examples are understandable and usable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c, ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100