mapbox / mapbox/tilelive-vector

Suggestion for improvement: Better samples

Open
#123 0 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
72
Forks
42
PR merge metrics
No merged PRs in 30d

Description

It would be helpful for newcomers to the tilelive modules to have a fully working sample they can run. It is a bit daunting getting into this, as there are quite a lot of libraries and moving parts to understand.

I'm struggling to get a working version of converting my own vector tiles to PNGs using this, which is something those familiar with the code can probably do very quickly. Working examples would go a long way to helping in understanding I think.

Thanks

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 examining the tilelive modules and the vector-tile-to-PNG workflow described in the issue, identifying the libraries and moving parts needed for a complete example. Done means a newcomer can run the sample to convert their own vector tiles to PNGs and use it to understand the setup.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.