Automating Reference Documentation publication
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 123
- Forks
- 34
- Avg merge
- 3h 48m
- Merged PRs (30d)
- 4
Description
Currently the reference documentation is built on releases and available as a zip file from the release hive.
https://github.com/Z3Prover/z3/releases/download/z3-4.9.1/z3doc.zip
Then I manually download this and unzip the contents into z3prover.github.io/api/html
It is a repository under https://github.com/z3prover
Commit and push
The process for uploading artifacts should be reasonably similar for releases.
Even a self-contained GitHub action that builds documentation by itself and pushes to the right place (could be microsoft.github.io/z3guide if this is better) would be great and perhaps easier to maintain than complicating the release.yml Azure pipeline.
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 reading the release.yml Azure pipeline and the current z3doc.zip release artifact process. Trace how documentation is built and how artifacts are uploaded, then define the publication target under z3prover.github.io/api/html or the proposed z3guide location. Done means a release automatically builds the reference documentation and publishes it to the chosen site without manual downloading or pushing.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- azure, github-actions
- Domain
- ci-cd, documentation, release
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100