Repository navigation
Lift the quick-start guide out of the release zip - #103
Merged
Merged
Conversation
cf-template.md is a port of the checker-framework repository's docs/checker-framework-webpage.html. The port dropped one bullet: the Dataflow Framework, described there as an industrial-strength dataflow framework used by the Checker Framework, Error Prone, NullAway and Nullsafe. Restore it, pointing at manual/checker-framework-dataflow-manual.pdf -- the URL the original page used, which was a 404 because the PDF was built at release time and then discarded. eisop/checker-framework now ships it in the release zip under docs/manual/, which this generator already lifts wholesale, so the link resolves with no change here. The quick-start guide had no counterpart on this site at all. It now travels in the release zip too, so lift it the same way CHANGELOG.md is lifted: out of <release>/docs/ to <release>/quick-start.html during the per-release loop, then copy the newest to cf/quick-start.html. Releases predating its addition to the zip simply do not have it, so both steps are guarded on the file existing. Link it from the front page, both as the "Quick start" entry and under Documentation. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
`mvn package` writes target/, and the repository has no .gitignore, so the compiled classes and both jars were committed here by an earlier `git add -A`. Remove them from the index; the .gitignore that prevents a recurrence comes with the generator fixes on the other branch. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Member
Author
|
Merge this one last, after a Checker Framework release that contains the two files. The other three website PRs (#101, #102, #104) are safe to merge and regenerate at any time. This one is not, because the front page it produces links to content that only arrives in a release built after eisop/checker-framework#2097 merges. Verified against the published
So merging this and regenerating today yields three dead links. Nothing breaks otherwise: the generator's quick-start lift is guarded on the file existing, so it is simply skipped. The generator half of this PR is inert without the files, so if it is convenient to land that early, the |
wmdietl
added a commit
to eisop/checker-framework
that referenced
this pull request
Sep 16, 2026
Two documents were produced at release time and then discarded, because they only ever reached the interm site directory that nothing publishes for eisop. docs/checker-framework-quick-start.html was kept version-correct by update-checker-framework-versions but shipped nowhere and appeared on no website. Add it to checker-includes so it travels in the release zip alongside the manual, the tutorial and the CHANGELOG. Its links pointed at https://eisop.github.io/cf/manual/#anchor, which resolves only through the 404 page's JavaScript redirect; make them site-relative so they work both at cf/quick-start.html and in an archived cf/<release>/quick-start.html. release_build.py already runs `make` in dataflow/manual, and checker-framework-website-docs copies the result to the interm directory under the very name the old front page linked to. Add it to the zip at docs/manual/checker-framework-dataflow-manual.pdf with a fullpath zipfileset, the mechanism already used for CFLogo.png. Because the website generator lifts docs/manual wholesale, it surfaces at cf/manual/checker-framework-dataflow-manual.pdf with no generator change. eisop/eisop.github.io#103 lifts the quick-start guide to cf/quick-start.html, restores the Dataflow Framework bullet that was dropped when the front page was ported to cf-template.md, and links both from the front page. checker-framework-webpage.html is deliberately left untouched here: a follow-up PR ships it in the release zip as that release's own page, which is the opposite of the "not published, do not edit" note that would otherwise have landed with this commit. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The Dataflow bullet and the quick-start links added here are superseded by eisop/checker-framework#2099, which ships docs/checker-framework-webpage.html in the release zip so that each release carries its own front page. That page already has the Dataflow bullet -- it is the page cf-template.md was ported from, and the port is where the bullet was lost -- and #2099 adds the quick-start links to it. Editing the template here as well would mean landing links to files that no published release contains, then reverting them when the template retires. Drop that half; the generator change stays, since the quick-start guide has to be lifted out of the release zip either way. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
wmdietl
changed the title
This was referenced Sep 16, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Safe to merge with the others now. The
cf-template.mdhalf of this PR has been dropped — see below — so nothing here links to content that no published release contains.What it does
The Checker Framework release will ship
docs/checker-framework-quick-start.html(eisop/checker-framework#2097). This lifts it the same waydocs/CHANGELOG.mdis already lifted: out of<release>/docs/to<release>/quick-start.htmlduring the per-release loop, then the newest is copied tocf/quick-start.html.Releases predating its addition to the zip do not contain it, so both steps are guarded on the file existing. That makes this change inert until the first release that carries the guide — merging it early simply means the site is ready the moment that release lands.
What was dropped, and why
This PR originally also added the Dataflow Framework bullet and the quick-start links to
cf-template.md. Both are superseded by eisop/checker-framework#2099, which shipsdocs/checker-framework-webpage.htmlin the release zip so each release carries its own front page.That page is the one
cf-template.mdwas ported from, and the port is where the Dataflow bullet was lost. #2099 restores the whole arrangement at the source and adds the quick-start links there.The reason not to do it in both places: one template shared across every release is a standing mismatch. A link added for content that first ships in release N is broken on the archived page of every release before N — permanently, not just until the next release. Editing the template here would have landed three dead links today and been reverted later, when
cf-template.mdretires in favour of the shipped page.Testing
mvn packageandmvn spotless:checkpass.🤖 Generated with Claude Code
https://claude.ai/code/session_012n7eKNuv1S2mTden7x56ie