feat: add multi-version docs support - #237
Conversation
Enable native versioning for a specific version of Shipwright Build Add version dropdown to navbar Fixes shipwright-io#136 Signed-off-by: Ernst Schacherl <git+shipwright@schacherl.dev>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
adambkaplan
left a comment
There was a problem hiding this comment.
/lgtm
I love it!
Regarding sequencing - since we just announced v0.20, I'd rather add multi-version docs support now. This has a substantial benefit since adopters and users will see the "released" docs by default, giving us flexibility to modify structure for the "next" release.
|
@shipwright-io/approvers could someone please take a look? |

Changes
Enables Docusaurus's native versioned docs so users can view documentation for a specific released version of Shipwright Build, instead of only ever seeing the latest unreleased state.
0.20, matching the current latest Build release line (v0.20.x)./docs/path serves the latest released version (0.20), and the unversioneddocs/folder (trackingmain, i.e. unreleased work) serves at/docs/next/. This matches the convention used by Jest, React Native, and Docusaurus's own docs site.Note on sequencing vs. SHIP-0041
I'm aware of the (still
provisional, unimplemented) SHIP-0041 docs restructure proposal. Cutting a version now means this first0.20snapshot stays in the currentbuild/getting-started/reflayout even if/when that restructure lands later — subsequent versions cut after a restructure would just pick up the new layout. This is the same tradeoff every project with versioned docs eventually hits (older versions naturally look structurally different from current docs), so I don't think it should block this from landing. Happy to hold off if maintainers feel otherwise.Related Issue
Fixes #136
Type of PR
/kind feature
Submitter Checklist
Release Notes