mapbox / mapbox/mapbox-gl-js

[docs] The relation between source type and rendering type needs to be clarified.

Open
#5,729 1 comment 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs :scroll: style-spec
Dominant language
TypeScript
Stars
12.4k
Forks
2.4k
PR merge metrics
No merged PRs in 30d

Description

In mapbox-style-spec, we have `source types` as:
```
vector
geojson
raster
image
video
canvas
```

And then we have `rendering type` as:
```
fill
fill-extrusion
line
symbol
circle
heatmap
raster
```

However, the docs did not say a souce type can be rendered as wich rending type, or a rendering type should specify which type of source. For example, how to add a layer that have a image\video\canvas type.

I conclude as below:
![image](https://user-images.githubusercontent.com/1522494/33059052-9228ff74-cecd-11e7-8b78-e3d3264edf2e.png)

I think the docs should clarify this relation.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the mapbox-style-spec documentation for source types and rendering types. Document which rendering types accept each source type, including image, video, and canvas, and describe how to add layers for them. Done means the supported relationships and usage guidance are explicit.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.