mapbox / mapbox/tilejson-spec

vector_layers for raster tilesets

Open
#67 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
296
Forks
51
PR merge metrics
No merged PRs in 30d

Description

The current text of 3.0.0 has a couple of problems for raster layers

Note: When describinng a set of raster tiles or other tile format that does not have a "layers" concept (i.e. "format": "jpeg"), the vector_layers key is not required.

There's a few issues that should be changed for 3.0.1

  1. Typo in "describinng"
  2. use of "i.e." In a case where there is an example, it should be e.g., not i.e., as the latter says jpeg is the only raster tile format
  3. Referencing format. Previous versions of the spec had a format key, but that is no longer defined in the spec, so it's unclear to users what "format": "jpeg" means
  4. Making it optional. The text earlier in the section says vector_layers is required, but this changes that. Instead of sorting that out, I recommend making it optional. For vector tiles with a layer concept, it's not always necessary to know what all the layers are in order to make use of the tiles.

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

Read the 3.0.0 raster-layer note and the surrounding section, then compare the wording with the earlier spec versions referenced in the issue. Correct the typo and example terminology, clarify or remove the obsolete format reference, and resolve whether vector_layers is optional so the final requirement is consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
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.