mapbox / mapbox/mapbox-speech-swift
Publish documentation
Nobody has claimed this yet.
- Dominant language
- Swift
- Stars
- 46
- Forks
- 16
- PR merge metrics
- No merged PRs in 30d
Description
MapboxSpeech’s public API is used in tandem with MapboxNavigation’s public API, so it should be documented and the documentation should be published somewhere easily accessible. Unlike with MapboxDirections, I think we can rely on the same simple GitHub Pages setup as in mapbox/turf-swift#162. MapboxSpeech is only a minor part of working with MapboxNavigation, and we don’t intend to productize it or the Mapbox Voice API as a standalone product.
/cc @mapbox/navigation-ios @mapbox/docs
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 by reviewing MapboxSpeech’s public API and the GitHub Pages setup used in mapbox/turf-swift#162. Document the API used with MapboxNavigation and publish the resulting documentation somewhere easily accessible; done means the documentation is available through the chosen public GitHub Pages setup.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- swift
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100