Versioning
Version your documentation
Strategies for versioning documentation with fromsrc.
Branch-based versioning
Use git branches to maintain different doc versions:
docs/index.mdx
docs/installation.mdx
Deploy each branch to a subdomain:
docs.example.com→ main branch (latest)v1.docs.example.com→ v1 branch
Pros
- No content duplication in main branch
- Independent builds per version
- Clean git history
Cons
- Requires multiple deployments
- Harder to search across versions
Folder-based versioning
Keep all versions in a single branch:
index.mdx
Content loader
Version switcher
Pros
- Single deployment
- Easy to search across versions
- Unified navigation
Cons
- Larger repo size
- Potential content duplication
API versioning
For API docs, use a date-based system (like Stripe):
Deprecation notice
Recommendation
For most projects, branch-based versioning is simpler:
- Maintain docs alongside code in feature branches
- Deploy latest docs from main
- Archive old versions to version branches
- Link to archived docs from main site