andras/vault-link
1
0
Fork 0
Code Issues Pull requests 18 Projects Releases 55 Packages Wiki Activity Actions 1

Enforce british english

Browse source
This commit is contained in:
Andras Schmelczer 2025-11-22 12:42:16 +00:00
parent dbce35c09f
commit 7f2b3ee928
14 changed files with 147 additions and 32 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/guide/alternatives.md
View file

@ -1,10 +1,10 @@
# Comparison with Alternatives
VaultLink is one of several solutions for synchronizing Obsidian vaults. This page compares VaultLink with popular alternatives to help you choose the right tool.
VaultLink is one of several solutions for synchronising Obsidian vaults. This page compares VaultLink with popular alternatives to help you choose the right tool.
## Key Differentiator: Editor Agnostic
**VaultLink is not tied to Obsidian.** While it includes an Obsidian plugin for convenience, VaultLink synchronizes plain text files and works with any editor:
**VaultLink is not tied to Obsidian.** While it includes an Obsidian plugin for convenience, VaultLink synchronises plain text files and works with any editor:
- Edit with **Obsidian desktop** on your laptop
- Edit with **Vim** on your server
@ -12,7 +12,7 @@ VaultLink is one of several solutions for synchronizing Obsidian vaults. This pa
- Edit with **Obsidian mobile** on your phone
- Use the **CLI client** for automated workflows
All changes merge automatically without conflict markers, regardless of which editor you use. This is possible because VaultLink uses [reconcile-text](/architecture/sync-algorithm#why-reconcile-text-over-crdts) for differential synchronization rather than requiring operation-level tracking.
All changes merge automatically without conflict markers, regardless of which editor you use. This is possible because VaultLink uses [reconcile-text](/architecture/sync-algorithm#why-reconcile-text-over-crdts) for differential synchronisation rather than requiring operation-level tracking.
## VaultLink's Core Strengths
@ -136,7 +136,7 @@ Before diving into comparisons:
**Downloads**: ~1.4M
**Repository**: https://github.com/denolehov/obsidian-git
**Overview**: Uses Git for version control and synchronization.
**Overview**: Uses Git for version control and synchronisation.
| Aspect | Obsidian Git | VaultLink |
| ------------------------- | ----------------------------- | ----------------------- |
@ -173,7 +173,7 @@ Before diving into comparisons:
**Downloads**: ~22,600
**Repository**: https://github.com/LBF38/obsidian-syncthing-integration
**Overview**: Wrapper around Syncthing for file synchronization.
**Overview**: Wrapper around Syncthing for file synchronisation.
| Aspect | Syncthing Integration | VaultLink |
| ------------------------- | ------------------------------ | ----------------- |
@ -228,7 +228,7 @@ Before diving into comparisons:
**Downloads**: ~5,000
**Repository**: https://github.com/alex-donnan/SyncFTP
**Overview**: Simple FTP-based file synchronization.
**Overview**: Simple FTP-based file synchronisation.
| Aspect | SyncFTP | VaultLink |
| ------------------------- | ---------------------- | ---------------- |
@ -239,7 +239,7 @@ Before diving into comparisons:
**When to use SyncFTP**: Don't use SyncFTP for any scenario where data integrity matters.
**When to use VaultLink**: Any scenario requiring reliable synchronization.
**When to use VaultLink**: Any scenario requiring reliable synchronisation.
---
@ -270,7 +270,7 @@ VaultLink is the **only** solution that combines:
2. **Editor agnostic** operation (not locked to Obsidian)
3. **Automatic conflict-free merging** using operational transformation
4. **Real-time collaborative editing** with cursor tracking
5. **Differential synchronization** supporting out-of-band edits
5. **Differential synchronisation** supporting out-of-band edits
6. **Comprehensive test coverage** ensuring reliability
7. **Simple deployment** via Docker or single binary

2
docs/guide/cli-client.md
View file

@ -195,7 +195,7 @@ vaultlink \
### Long-Running Sync
Run as a daemon for continuous synchronization:
Run as a daemon for continuous synchronisation:
```bash
docker run -d \

4
docs/guide/obsidian-plugin.md
View file

@ -96,7 +96,7 @@ When first connecting:
1. The plugin uploads all local files to the server
2. Downloads any missing files from the server
3. Resolves any conflicts using operational transformation
4. Begins real-time synchronization
4. Begins real-time synchronisation
Initial sync time depends on vault size and `sync_concurrency` setting.
@ -107,7 +107,7 @@ Once connected:
- **File changes**: Automatically synced when saved
- **File creation**: New files immediately uploaded
- **File deletion**: Deletions propagated to other clients
- **File renames**: Tracked and synchronized
- **File renames**: Tracked and synchronised
The plugin watches your vault filesystem and syncs changes in real-time via WebSocket.

2
docs/guide/server-setup.md
View file

@ -347,7 +347,7 @@ docker logs vaultlink-server
- Reduce `max_connections_per_vault`
- Reduce `max_clients_per_vault`
- Check for large vaults (may need database optimization)
- Check for large vaults (may need database optimisation)
### Database corruption

2
docs/guide/what-is-vaultlink.md
View file

@ -13,7 +13,7 @@ Syncing Obsidian vaults across devices or sharing with teammates sucks:
## VaultLink's Solution
Differential synchronization with operational transformation.
Differential synchronisation with operational transformation.
Edit files with Obsidian, Vim, VS Code, or any editor. VaultLink compares versions and automatically merges all changes. No operation tracking required, no conflict markers, no data loss.