mapbox / mapbox/mapbox-gl-geocoder
Add more detail to Usage section in README
Open
Nobody has claimed this yet.
docs improvement
- Dominant language
- JavaScript
- Stars
- 388
- Forks
- 181
- PR merge metrics
- No merged PRs in 30d
Description
We should build out the usage section in the README to better explain how to use gl-geocoder
https://github.com/mapbox/mapbox-gl-geocoder#usage
Ideas:
* Include brief sentence on how to implement.
* Link to gl-js examples to highlight different features and implementation options.
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 the Usage section in README and review the linked mapbox-gl-js examples. Add a brief implementation explanation and links that show different features or implementation options; the work is done when the Usage section clearly explains how to use gl-geocoder.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100