mapbox / mapbox/mapbox-navigation-android
Separating release documentation between release tags
Nobody has claimed this yet.
- Dominant language
- Kotlin
- Stars
- 651
- Forks
- 321
- PR merge metrics
- No merged PRs in 30d
Description
When a repository has multiple release channels. It has an issue of publishing documentation to the main release channel.
Both maps and navigation have separate release channels for android auto
- Maps [extension-androidauto-v0.1.0](https://github.com/mapbox/mapbox-maps-android/releases/tag/extension-androidauto-v0.1.0)
- Navigation [androidauto-v0.1.0](https://github.com/mapbox/mapbox-navigation-android/releases/tag/androidauto-v0.1.0)
But the documentation is part of the main release channel
- Maps androidauto docs bundled with [10.6.0-rc.1](https://docs.mapbox.com/android/maps/api/10.6.0-rc.1/mapbox-maps-android/com.mapbox.maps.extension.androidauto/)
- Navigation androidauto docs bundled with [2.6.0-alpha.2](https://docs.mapbox.com/android/navigation/api/2.6.0-alpha.2/libnavui-androidauto/-u-i%20-car/)
This is not really a big deal for developer previews. But it will be an issue if one of these other release channels needs to become a stable release. We'll want to have documentation bundled with the specific versions
cc: @MrSwimmer @pengdev @mikelmaron
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 or tests are named. Start by comparing the linked Maps and Navigation release tags with the currently bundled Android Auto documentation versions. Done means documentation can be bundled with the specific release-channel versions rather than only the main release channel.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kotlin
- Domain
- documentation, release
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100