Generate and publish documentation on CI
Nobody has claimed this yet.
- Dominant language
- Swift
- Stars
- 271
- Forks
- 65
- PR merge metrics
- No merged PRs in 30d
Description
We should adapt the work @chezzdev did in mapbox/mapbox-navigation-ios#3439 mapbox/mapbox-navigation-ios#3469 to run the jazzy documentation generation script on CI for every PR and push it to publisher-production for release tags. This will completely automate a whole section of [the release process](https://github.com/mapbox/turf-swift/wiki/Releasing-Turf-swift#update-the-documentation).
/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
Review the referenced mapbox-navigation-ios changes and the existing jazzy documentation generation script first. Determine how CI should run it for every pull request and push documentation to publisher-production for release tags; done means the release-process documentation update is fully automated.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- swift
- Domain
- ci-cd, documentation, release
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100