Update overview w/ Query-Driven Sync and other features/arguments #812
+80
−18
Conversation
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
Updates the overview documentation to better reflect the content and features from the two DB blog posts (0.1 and 0.5): - Add compelling "Option C" narrative explaining the architecture problem TanStack DB solves (view-specific APIs vs load-everything) - Document Query-Driven Sync feature from 0.5 release: - Three sync modes: eager, on-demand, progressive - How component queries automatically become API calls - Request optimization (collapsing, delta loading, join batching) - Add concrete performance numbers: ~0.7ms updates for 100k items on M1 Pro, demonstrating truly instantaneous optimistic updates - Expand sync engine benefits section: - Easy real-time updates without WebSocket plumbing - Automatic side-effects and cache invalidation - Efficient delta updates enabling "load everything once" pattern These changes bridge the gap between the technical reference docs and the compelling narrative from the blog posts, helping developers understand both why TanStack DB exists and how to use it effectively.
|
Highlights that apps can't get sluggish due to too much data, with queries over 100k+ rows completing in under a millisecond. This makes the end-user experience benefit clear early in the documentation.
More templates
@tanstack/angular-db
@tanstack/db
@tanstack/db-ivm
@tanstack/electric-db-collection
@tanstack/offline-transactions
@tanstack/powersync-db-collection
@tanstack/query-db-collection
@tanstack/react-db
@tanstack/rxdb-db-collection
@tanstack/solid-db
@tanstack/svelte-db
@tanstack/trailbase-db-collection
@tanstack/vue-db
commit: |
Contributor
|
Size Change: 0 B Total Size: 85.8 kB ℹ️ View Unchanged
|
Contributor
|
Size Change: 0 B Total Size: 3.34 kB ℹ️ View Unchanged
|
Rewrites the introduction to: - Lead with the problems TanStack DB solves (endpoint sprawl, client performance, network on interaction path) - Emphasize the end-user benefit upfront: interactions feel instantaneous, app stays fast regardless of data volume - Present the "new way" as numbered benefits rather than "Option C" framing - More action-oriented and benefit-focused language This makes the value proposition clearer and more compelling for developers evaluating TanStack DB.
Contributor
|
This looks great to merge. One additional thing is whether to also update the project homepage to (I've updated the repo settings on GitHub). |
Aligns README with the refined overview.md framing: - Changes "client-first" to "client" to match new terminology - Adopts problem-solution framing (avoid endpoint sprawl, optimize client performance, take network off interaction path) - Emphasizes end-user benefit: app stays fast regardless of data - More action-oriented and benefit-focused language Keeps README concise while maintaining consistency with docs.
Aligns the core package README with the refined messaging: - Updates tagline to "The reactive client store for your API" - Adds "solves the problems of building fast, modern apps" - Rewrites bullet points to focus on problem-solution framing: - Avoid endpoint sprawl (vs building custom endpoints) - Blazing fast queries (app stays fast regardless of data) - Instant interactions (network off interaction path) - Fine-grained reactivity (minimize re-rendering) Makes the npm package description more benefit-oriented.
KyleAMathews
deleted the
claude/review-db-blog-posts-01NNYEE1vg53mQo1xY3442Br
branch
Collaborator
Author
|
yeah good call — I'll update tanstack.com now |
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.
Updates the overview documentation to better reflect the content and features from the two DB blog posts (0.1 and 0.5):