docs: Add version switcher - Make v0.5.x the default (Latest) #93
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.
Add Documentation Version Switcher
Summary
Implements version switcher for Litestream documentation to support both v0.3.13 and v0.5.x versions. This addresses issue #92 by providing clear version guidance and making v0.5.x the new default "Latest" version.
Changes
Version Terminology
Implementation Details
Branches
docs-v0.5→ Latest version (will become new main)docs-v0.3→ Previous version (archived, critical fixes only)main→ Will point to latest (v0.5 after merge)🚨 Required: Netlify Configuration (2 minutes)
Ben - You need to enable branch deploys in the Netlify dashboard before merging this PR.
Steps:
This enables Netlify to automatically deploy the
docs-v0.3branch so users can access previous version docs.What This Does:
docs-v0-3--litestream.netlify.appOptional: Custom Domain
If you want a cleaner URL (recommended):
v0-3.litestream.io→ points todocs-v0-3branch deployDeployment Plan (Zero Downtime)
Current State
mainbranch → v0.3.13 contentAfter Merge (Automatic)
docs-v0.5→mainmainResult
Future Version Releases (v0.6, v0.7, etc.)
NO dashboard changes needed! Just:
docs-v0.6mainPrevious versions remain accessible via branch URLs automatically.
Testing
✅ Local builds verified:
Local Testing Instructions
Option 1: View One Version at a Time (Simple)
View v0.5 (Latest):
git checkout docs-v0.5 npm run start # Visit http://localhost:1313View v0.3 (Previous):
You'll see the version banner at the top with appropriate styling and labels.
Option 2: View Both Versions Side-by-Side (Advanced)
Uses git worktrees to run both versions simultaneously in isolated directories:
Terminal 1 - v0.5 (Latest):
git checkout docs-v0.5 npm run start # Visit http://localhost:1313Terminal 2 - v0.3 (Previous) in separate worktree:
Now you can compare both versions side-by-side in different browser tabs!
Cleanup when done:
cd ../litestream.io git worktree remove ../litestream.io-v0.3Note: Version switcher links will show placeholder URLs until Netlify branch deploys are enabled. The banner styling and version labels will work correctly.
Screenshots
Version banner on v0.5 (Latest):
Version banner on v0.3 (Previous):
Checklist for Ben
Resolves
Closes #92