docs: add version switcher to the docs header#2044
Merged
Conversation
Adds a select to the header that lets readers switch between the 2.x and 1.x documentation. Versions are configured via the 'versions' array in app.config.ts.
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
1 participant
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.
Adds a version select to the docs header so readers can switch between the 2.x and 1.x documentation.
AppVersionSelect.vue: small themed<select>; entries come from the newversionsarray inapp.config.ts(current: truemarks the version the deployment serves), so adding future versions is a one-line config change. Hidden automatically when fewer than two versions are configured.AppHeader.vue: override of the Docus header (same mechanism as the existingLogo.vueoverride) that places the select next to the color-mode toggle.https://v1.pinia-orm.codedredd.deas a placeholder — a deployment of the1.xbranch docs needs to exist there (e.g. a second Vercel project on the1.xbranch with that domain), or adjust the URL to wherever the old docs live.1.xbranch docs should get the same component (withcurrenton 1.x) so visitors can switch back — happy to cherry-pick this onto1.xonce the domain is decided.