Skip to content

Rewrite offline-database article with modern sync section and improvement guide - #8939

Merged
pubkey merged 2 commits into
masterfrom
claude/offline-database-page-rewrite-h1s1rz
Aug 10, 2026
Merged

Rewrite offline-database article with modern sync section and improvement guide#8939
pubkey merged 2 commits into
masterfrom
claude/offline-database-page-rewrite-h1s1rz

Conversation

@pubkey

@pubkey pubkey commented Aug 10, 2026

Copy link
Copy Markdown
Owner

This PR contains:

  • IMPROVED DOCS

Describe the problem you have without this PR

The articles/offline-database.md page was outdated. Its sync section described the replication only vaguely (and mentioned PouchDB), the content was thin on what an offline database is, and it gave no guidance on how to improve a setup beyond the basics. This PR fully rewrites the page:

  • New structure: what an offline database is (vs a cache), why apps need one, RxDB intro, setup example, sync, encryption, improvement guide, FAQ, Follow Up.
  • The sync section now describes the modern RxDB Sync Engine: the git-like document-level protocol, the three backend endpoints (pull handler, push handler, pull stream), checkpoint iteration and event observation modes, client-side conflict resolution, batched transfers, multi-tab leader election, and the current replication plugin list (HTTP, GraphQL, WebSocket, CouchDB, Firestore, MongoDB, Supabase, Appwrite, NATS, WebRTC/P2P, RxServer). The code sample uses realistic fetch-based pull/push handlers instead of empty placeholders.
  • A new "How to Improve Your Offline Database Setup" section with eight concrete steps: storage choice, partial sync, cleanup of deleted documents, key compression, worker/shared-worker storages, schema migrations, deliberate conflict handling, and knowing the tradeoffs.
  • The FAQ is rewritten to target real search queries with verdict-first answers.

The docs build (npm run docs:build) passes with no broken links on this page.

Todos

  • Documentation

Generated by Claude Code

claude added 2 commits August 10, 2026 12:10
…ment guide

Full rewrite of docs-src/docs/articles/offline-database.md:
- New structure: definition of an offline database, benefits, RxDB intro,
  setup example, Sync Engine, encryption, improvement steps, FAQ.
- Sync section now describes the modern RxDB Sync Engine: git-like
  document protocol, pull/push handlers plus pull stream, checkpoint
  iteration and event observation modes, client-side conflict
  resolution, batching, leader election, and the current list of
  replication plugins (Supabase, Appwrite, MongoDB, NATS, Firestore,
  CouchDB, GraphQL, HTTP, WebSocket, WebRTC, RxServer).
- New section with eight suggestions on how to improve an offline
  database setup: storage choice, partial sync, cleanup, key
  compression, worker storages, schema migrations, conflict handling,
  and knowing the tradeoffs.
- Rewritten FAQ targeting real search queries with verdict-first
  answers.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01FunfQhtwvQumvwSbU2k8gF
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01FunfQhtwvQumvwSbU2k8gF
@pubkey
pubkey merged commit a9e791d into master Aug 10, 2026
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants