mapbox / mapbox/mapbox-gl-draw
Make "docs/API.md" auto generated from "src/api.js"
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 1.1k
- Forks
- 612
- Avg merge
- 8d 9h
- Merged PRs (30d)
- 5
Description
Right now [docs/API.md](https://github.com/mapbox/mapbox-gl-draw/blob/e8fbe8b7231df563e2242ea38e02ac8078725bcd/docs/API.md) are hand written which gives us a lot of control over how they are formatted, but it leads to them being out of sync with what is in [src/api.js](https://github.com/mapbox/mapbox-gl-draw/blob/e8fbe8b7231df563e2242ea38e02ac8078725bcd/src/api.js). Lets move these docs over to [documentation.js](http://documentation.js.org/) like we have done for [docs/MODES.md](https://github.com/mapbox/mapbox-gl-draw/blob/e8fbe8b7231df563e2242ea38e02ac8078725bcd/docs/MODES.md).
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 comparing docs/API.md with src/api.js, then inspect how docs/MODES.md was moved to documentation.js. Update the documentation setup so API documentation is generated from src/api.js, and verify that docs/API.md reflects the source API and remains synchronized through the same approach.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 48/100