"API Specification" Style Documentation
Open
Nobody has claimed this yet.
Documentation
hacktoberfest
Help wanted
Needs investigation
pinned
- Dominant language
- JavaScript
- Stars
- 9.8k
- Forks
- 808
- PR merge metrics
- No merged PRs in 30d
Description
I would love to see API Specification style documentation for Sinon, along the lines of what you see in Java (the gold standard of documentation), or jQuery.
An A-Z alphabetical list of functionality, written in a non-conversational way (which is how the current documentation is currently written) is what this documentation needs.
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
No file or test is named. Start by reviewing Sinon’s current documentation and public API, then compare its organization with the linked Java and jQuery examples. Done means an agreed A–Z, non-conversational API reference covering the project’s functionality.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100