esp8266/Arduino

Create API reference

Open

#18 opened on Mar 30, 2015

View on GitHub
 (10 comments) (0 reactions) (0 assignees)C++ (13,342 forks)batch import
component: documentationhelp wanted

Repository metrics

Stars
 (15,728 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Describe all the basic APIs and the libraries by adding documentation to the repository or to the wiki.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

Contributor guide

Research direction
Examine the source code to identify all public APIs and libraries, then document them in the repository's wiki or as markdown files.
Tech stack
cpp
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
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
GitArduino
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80