Rewrite offline-database article with modern sync section and improvement guide - #8939
Merged
Merged
Conversation
…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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR contains:
Describe the problem you have without this PR
The
articles/offline-database.mdpage 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:The docs build (
npm run docs:build) passes with no broken links on this page.Todos
Generated by Claude Code