improve cross linking GL JS docs to style spec docs
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 12.4k
- Forks
- 2.4k
- PR merge metrics
- No merged PRs in 30d
Description
For example the [map.getFilter documentation](https://www.mapbox.com/mapbox-gl-js/api/#map#getfilter) says `Returns the filter applied to the specified style layer.`.
What's the feeling on having "filter" being a link to the style spec at https://www.mapbox.com/mapbox-gl-js/style-spec/#types-filter :+1: :-1: ?
There are quite a few places where more direct links to the style spec could be added.
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 map.getFilter documentation at the linked GL JS API page and compare its “filter” reference with the style-spec filter page. Review other GL JS API references for style-spec concepts and identify which should link directly; done means the intended cross-links are agreed and added consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100