Skip to content

docs: update overview and installation with PowerSync collection reference#1362

Open
devagrawal09 wants to merge 2 commits intoTanStack:mainfrom
devagrawal09:docs/powersync-overview-update
Open

docs: update overview and installation with PowerSync collection reference#1362
devagrawal09 wants to merge 2 commits intoTanStack:mainfrom
devagrawal09:docs/powersync-overview-update

Conversation

@devagrawal09
Copy link

@devagrawal09 devagrawal09 commented Mar 13, 2026

🎯 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

  • I have tested this code locally with pnpm test.

🚀 Release Impact

  • This change affects published code, and I have generated a changeset.
  • This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

  • Documentation
    • Added comprehensive PowerSync Collection documentation with installation commands, configuration options, and platform compatibility information
    • Introduced PowerSync as an additional synchronization option alongside existing solutions
    • Expanded overview documentation with PowerSync code examples and integration guidance
    • Updated usage examples to include PowerSync setup scenarios

@changeset-bot
Copy link

changeset-bot bot commented Mar 13, 2026

⚠️ No Changeset found

Latest commit: 5f7d558

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link

coderabbitai bot commented Mar 13, 2026

📝 Walkthrough

Walkthrough

Documentation 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

Cohort / File(s) Summary
PowerSync Documentation
docs/installation.md, docs/overview.md
Added PowerSync collection documentation with installation commands, configuration options, platform support, code examples, and integration details. Updated overview to list PowerSync alongside ElectricSQL as a sync option.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A hop through the docs, what delight!
PowerSync shines in the digital light,
Installation clear, examples so fine,
Hopping from sync to another design. ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: updating overview and installation documentation with PowerSync collection references.
Description check ✅ Passed The description follows the template structure with all required sections completed: Changes section explains the updates, Checklist confirms local testing, and Release Impact correctly marks it as docs-only without requiring a changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📝 Coding Plan
  • Generate coding plan for human review comments

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

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 biome.

@devagrawal09 devagrawal09 marked this pull request as ready for review March 13, 2026 03:38
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between a452ca7 and 8a4fe90.

📒 Files selected for processing (2)
  • docs/installation.md
  • docs/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.
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