Documentation
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2.6k
- Forks
- 477
- Avg merge
- 6h 13m
- Merged PRs (30d)
- 75
Description
Maputnik needs better documentation. Over the course of the year there have been a few issues raised and comments in issues with people confused what Maputnik actually does. I don't think it's that clear from the project what it does and what it's aims are.
How about we create a documentation repository (maputnik/docs) and start building some good documentation.
My initial thoughts of what would be good to cover
- The goal of Maputnik (an editor for the MapboxGL style spec)
- Worked through use cases
- Base map
- Data vis
- An explanation of data sources
- Common issues when using Maputnik
So basically it'd be a guide to both using Maputnik and to some extent working with the MapboxGl style spec. Although if you have better ideas feel free to run with them
Would anybody be interested taking on the challenge?
I would prefer someone with prior experience, I'm going to nominate @gregorywolanski @pathmapper @keum. I realise this is quite a lot of work, so there's no pressure intended from me.
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
No files, tests, or entry points are named. Start by reviewing Maputnik's purpose as an editor for the MapboxGL style spec and the proposed topics: goals, base-map and data-visualization use cases, data sources, and common issues. Done would be a documentation repository covering how to use Maputnik and work with the style spec.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100