sinonjs/sinon

"API Specification" Style Documentation

Open

#2,003 opened on Apr 2, 2019

View on GitHub
 (14 comments) (1 reaction) (0 assignees)JavaScript (9,548 stars) (764 forks)batch import
DocumentationHelp wantedNeeds investigationhacktoberfestpinned

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

Tech stack
javascript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaScript basicsSinon API knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
Review existing Sinon documentation structure and consider templates from jQuery API docs. Discuss with maintainers about scope and format. Possibly start with a single function like `sinon.spy` as a prototype.
"API Specification" Style Documentation · sinonjs/sinon#2003 | Good First Issue