Migrate Collection Info to Dedicated Pages #725
Merged
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
- Created dedicated pages for each collection type: - trailbase-collection.md - local-storage-collection.md - local-only-collection.md - derived-collections.md - Simplified overview.md Collections section: - Reduced from ~743 to 408 lines (45% reduction) - Replaced detailed content with brief one-sentence descriptions - Added links to individual collection type pages - Each collection page includes: - Overview and use cases - Installation instructions - Configuration options - Code examples - Complete working examples - Cross-references to related documentation This makes the documentation more navigable and easier to maintain. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
|
Reorganized the collection types in overview.md into logical categories: - Fetch Collections: QueryCollection - Sync Collections: ElectricCollection, TrailBaseCollection, RxDBCollection - Local Collections: LocalStorageCollection, LocalOnlyCollection - Derived Collections: Derived Collections This makes it easier to understand the different collection types at a glance. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
More templates
@tanstack/angular-db
@tanstack/db
@tanstack/db-ivm
@tanstack/electric-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: 84.5 kB ℹ️ View Unchanged
|
Contributor
|
Size Change: 0 B Total Size: 2.89 kB ℹ️ View Unchanged
|
samwillis
requested changes
Oct 31, 2025
Collaborator
There was a problem hiding this comment.
Do we really need a page for "derived collections"? these are what you get from a live query, and we have the live query docs?
- Removed derived-collections.md page (covered in live queries docs) - Removed RxDBCollection from overview (being removed from library) - Removed arbitrary "When Not to Use" sections from local collection docs - Added storageEventApi documentation to LocalStorageCollection: - Documents custom event API for cross-tab/process sync - Added to optional options list - Included examples for Electron, WebSocket, and IPC use cases Changes based on feedback from @samwillis
…ction-docs-011CUXhbpUwQkUkz2fq7qQhx
Clarified that server collection mutations are handled by their operation handlers (onInsert, onUpdate, onDelete), not automatically without configuration. Updated comments to match the pattern shown in the mutations guide. Before: "Server collection mutations are handled automatically" After: "Server collection mutations are handled by their onInsert handler automatically (onInsert will be called and awaited first)"
Fixed a critical misunderstanding about how manual transactions work.
When using createTransaction, the collection's operation handlers
(onInsert, onUpdate, onDelete) are NOT automatically called. The
mutationFn is responsible for handling ALL persistence.
Changed examples from:
// Server collection mutations are handled automatically
To the correct pattern:
// Handle server collection mutations explicitly in mutationFn
await Promise.all(
transaction.mutations
.filter((m) => m.collection === serverCollection)
.map((m) => api.items.create(m.modified))
)
Fixed in:
- docs/guides/mutations.md
- docs/collections/local-only-collection.md
- docs/collections/local-storage-collection.md
Changed 'with a generic ingestion endpoint' to 'for real-time sync with your existing API' to accurately match what the example shows (api.todos.create()).
…ction-docs-011CUXhbpUwQkUkz2fq7qQhx
KyleAMathews
deleted the
claude/refactor-collection-docs-011CUXhbpUwQkUkz2fq7qQhx
branch
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.
Created dedicated pages for each collection type:
Simplified overview.md Collections section:
Each collection page includes:
This makes the documentation more navigable and easier to maintain.
🤖 Generated with Claude Code
🎯 Changes
✅ Checklist
pnpm test:pr.🚀 Release Impact