Repository navigation
Publish the 3.x and 4.x documentation side by side - #1050
Merged
Merged
Conversation
The website now contains one book per major version, a version switcher in the menu bar of each book, and a redirect for every analyzer rule. Resolves #1046 Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
JudoJosef
approved these changes
Nov 5, 2026
29 tasks
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.
Resolves #1046
mainalready contains the 4.0 breaking changes and every push tomaindeploys the book, so the live documentation currently describes unreleased behaviour (andλ1202/λ1203, still reported by the shipped analyzers, return 404).What changes
STABLE_DOCUMENTATION_REF, the branchrelease/3.8.x) next tomain./funcky/book/is the stable 3.x book (default)/funcky/book/4.x/is the book frommain, labelled "4.x (preview)"Website/book/version-switcher.jsis injected into every book by the build script, so the 3.x sources need no change. It stays on the same page when the other version has it and falls back to the start of that book otherwise./funcky/analyzer-rules/{id}.html, but onlyλ0001had a redirect. The build now generates one for every rule page found in any book; a rule goes to the default book, or else to the first book that documents it.workflow_dispatchis added to redeploy after a change to the 3.x documentation.When 4.0.0 is released
Swap the two entries of
booksinWebsite/build.fsx: 4.x moves tobook, 3.x tobook/3.x, 4.x is listed first.Notes
release/3.8.x; the companion PR against that branch redeploys the website after such a change.docs.ymlonrelease/3.8.xwould deploy the single-book site on a 3.x tag; the companion PR removes that.