This document summarizes the documentation work completed on litestream.io over the past ~60 days.
| Metric | Count |
|---|---|
| Issues Closed | 57 |
| PRs Merged | 50 |
| Commits | 48 |
| Lines Added | 7,978 |
| Lines Deleted | 774 |
| Net Lines | +7,204 |
- Created dual-version documentation structure (v0.3.x and v0.5.x branches)
- Migrated from Netlify to GitHub Pages
- Added version switcher between v0.3 and v0.5 docs
- Set up branch protection for
mainanddocs-v0.3 - Added markdown linting CI workflow
| Guide | Lines Added | Description |
|---|---|---|
| VFS (Virtual File System) | ~580 | Comprehensive guide for embedded Go applications |
| S3 & S3-Compatible Storage | ~1,500 | Major rewrite with provider-specific configs |
| WebDAV Backend | ~260 | New replica backend documentation |
| Directory Watcher | ~306 | Dynamic database discovery feature |
| Directory Replication | ~275 | Multi-database replication guide |
| File-to-File Replication | ~130 | Local backup documentation |
| Azure SDK v2 Migration | ~314 | Migration guide for Azure users |
| modernc.org/sqlite Migration | ~214 | Pure-Go SQLite migration guide |
| Global Replica Defaults | ~441 | Configuration feature documentation |
| Environment Variables Reference | ~472 | Comprehensive env var reference |
| WAL Truncate Threshold | ~367 | Configuration guide |
| Alibaba Cloud OSS | ~155 | New cloud provider guide |
| MCP Server | ~388 | Enhanced Model Context Protocol docs |
- Tigris (Fly.io) - Added to S3-compatible providers guide
- OCI Object Storage - Oracle Cloud documentation
- Fixed GCS URL scheme (
gcs://→gs://) - Fixed Linode endpoint format inconsistency
- Corrected IAM policy issues and broken links
- Added MinIO remote server configuration
- Added Age encryption deprecation warning and migration guide
- Docker volume storage clarifications
- SFTP concurrent writes documentation
- NATS TLS client certificate documentation
- L0 retention configuration documentation
- SQLite connection string prefix support
-if-replica-existsflag documentation for restore command
This represents a substantial documentation overhaul—essentially bringing the docs up to full parity with v0.5.x features while maintaining a v0.3.x branch for users on the older CLI version.
The +7,200 net lines is predominantly new feature documentation that didn't previously exist, covering:
- The new VFS system for embedded Go applications
- Expanded cloud provider support
- Migration guides for SDK upgrades
- Comprehensive configuration references
All documentation is now versioned and automatically deployed via GitHub Actions.