Add API.md documenting all available methods
Open
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 384
- Forks
- 96
- PR merge metrics
- No merged PRs in 30d
Description
Quoting @artemp from https://github.com/mapbox/variant/pull/156#discussion_r127658875:
> it'll be better to have a separate page listing all available methods while README only mentions basic building blocks
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 with README.md and the API surface referenced by the request, using the existing documentation as the baseline for the basic building blocks. Done means API.md exists and lists all available methods beyond the README coverage; the issue provides no test target.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100