Add support for navigating to historic releases
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 2
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
We host every older version of our API docs in a versioned folder at `https://docs.mapbox.com/ios/api/maps/x.x.x` — let’s add a dropdown that allows users to navigate through them.
To implement this in the style, we may first need support upstream in jazzy itself or somehow provide a list of valid versions alongside the docs.
Examples:
_https://realm.io/docs/swift/latest/_
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 the jazzy theme and checking whether jazzy itself can expose a list of valid documentation versions. Compare the versioned API-docs URL pattern and the linked Realm example to define the dropdown behavior. Done means users can select an older release and navigate to its corresponding documentation without breaking the current version.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation, web-dev
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100