Add tutorial pages to docs
Open
Nobody has claimed this yet.
Documentation
- Dominant language
- JavaScript
- Stars
- 9.8k
- Forks
- 809
- PR merge metrics
- No merged PRs in 30d
Description
Each of the concepts in Sinon should have it's own tutorial pages, separate from the API documentation:
- Fakes
- Spies
- Stubs
- Sandboxes
- Faking time
- Mocks
- Spy calls
- Assertions
- Matchers
- Promises
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 locating Sinon’s existing API documentation and documentation structure, then determine where separate tutorial pages should live and how they should be organized. Done means tutorials cover Fakes, Spies, Stubs, Sandboxes, Faking time, Mocks, Spy calls, Assertions, Matchers, and Promises without replacing the API documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100