esp8266/Arduino

Create API reference

Open

#18 opened on Mar 30, 2015

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

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

Tech stack
ccpp
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
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.
mostly clear
Prerequisites
Basic knowledge of ESP8266 Arduino librariesFamiliarity with Markdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Examine the existing library source files (e.g., in the libraries/ directory) to identify all public APIs and functions. Document them in a structured format such as Markdown. Consider using a documentation generator like Doxygen if applicable. Check the 10 comments on the issue for any prior discussion about scope and preferred format.