Move documentation of common parameters like `sources`, `layers` to a common place
Open
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 269
- Forks
- 104
- PR merge metrics
- No merged PRs in 30d
Description
It's not clear that many of these parameters are applicable to the search, autocomplete, and reverse endpoints. Many of them are only documented on the page for the search endpoint.
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 the documentation for the search, autocomplete, and reverse endpoints, focusing on the common parameters sources and layers. Move shared parameter descriptions to a common place and ensure each applicable endpoint points to them, so readers can find the parameters consistently.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100