docs: update overview and installation with PowerSync collection reference#1362
docs: update overview and installation with PowerSync collection reference#1362devagrawal09 wants to merge 2 commits intoTanStack:mainfrom
Conversation
…rence Made-with: Cursor
|
📝 WalkthroughWalkthroughDocumentation updates adding PowerSync integration guidance to installation and overview sections. Includes setup instructions, usage examples, supported platforms, and configuration details alongside existing sync options like ElectricSQL. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment Tip CodeRabbit can use your project's `biome` configuration to improve the quality of JS/TS/CSS/JSON code reviews.Add a configuration file to your project to customize how CodeRabbit runs |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/installation.md`:
- Around line 102-105: The install snippet currently shows a Web-only command
(npm install `@tanstack/powersync-db-collection` `@powersync/web`
`@journeyapps/wa-sqlite`) while the text claims multi-platform support; split the
installation instructions into platform-specific subsections (Web, React Native,
Node.js) and provide the correct package sets for each (Web: `@powersync/web` +
`@journeyapps/wa-sqlite`, React Native: `@powersync/react-native` with adapters like
`@powersync/op-sqlite` or `@journeyapps/react-native-quick-sqlite`, Node.js:
`@powersync/node` with better-sqlite3), or explicitly scope this section to Web
only and update the descriptive text that references powerSyncCollectionOptions
and the PowerSync Collection docs to avoid implying the single install line
works for all platforms.
In `@docs/overview.md`:
- Line 522: The backend list in the overview sentence "PowerSync provides
offline-first sync with a SQLite-based local database and real-time
synchronization with PostgreSQL, MongoDB, MySQL, and SQL Server backends" should
include maturity tier qualifiers or be aligned with docs/installation.md; update
that sentence to either append qualifiers (e.g., "PostgreSQL (GA), MongoDB (GA),
MySQL (Beta), SQL Server (Alpha)") or remove SQL Server from the list to match
installation.md so the documentation is consistent and accurate.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 98b82408-122f-44fe-a0d5-ab3e2545540b
📒 Files selected for processing (2)
docs/installation.mddocs/overview.md
…ation Updated the installation guide to include platform-specific commands for PowerSync's SQLite adapter in both Web and React Native environments. Clarified that SQL Server is in Alpha stage for real-time synchronization support in the overview section.
🎯 Changes
Updates docs/overview.md and docs/installation.md to reference the PowerSync Collection documentation for full setup details including schema validation, type transformations, and advanced transactions.
✅ Checklist
pnpm test.🚀 Release Impact
Summary by CodeRabbit