Skip to content

New Sync Streams navigation - #640

Open
benitav wants to merge 12 commits into
mainfrom
sync-streams-nav
Open

benitav wants to merge 12 commits into
mainfrom
sync-streams-nav

Conversation

@benitav

@benitav benitav commented Sep 10, 2026

Copy link
Copy Markdown
Collaborator

Focus the current "Sync Streams/Rules" section in the sidebar on Sync Streams only; contain Sync Rules content in the "Sync Rules (legacy)" section.

Screenshot 2026-09-16 at 13 17 28

Previous nav:

Sync Streams & Rules
├── Overview                              (sync/overview)
├── Sync Streams
│   ├── Quickstart                        (sync/streams/overview)
│   ├── Using Parameters
│   ├── Writing Queries
│   ├── Common Table Expressions (CTEs)
│   ├── Bucket Count
│   ├── Examples & Demos
│   ├── Client-Side Usage
│   └── Migrating from Sync Rules         (sync/streams/migration)
├── Sync Rules (Legacy)
│   ├── Overview & Key Concepts
│   ├── Organize Data Into Buckets
│   ├── Global Buckets
│   ├── Parameter Queries
│   ├── Data Queries
│   ├── Many-to-Many and Join Tables
│   └── Client Parameters
├── Type Mapping
├── Supported SQL
│   ├── Guide
│   ├── Grammar Reference (Sync Streams)
│   └── Grammar Reference (Sync Rules)
└── Advanced
    ├── Overview
    ├── Reducing Buckets
    ├── Prioritized Sync
    ├── Client ID
    ├── Case Sensitivity
    ├── Compatibility
    ├── Storage Version 4
    ├── Sync Data by Time
    ├── Schemas and Connections
    ├── Multiple Client Versions
    ├── Partitioned Tables (Postgres)
    └── Sharded Databases

New nav:

Sync Streams                              ← group renamed from "Sync Streams & Rules"
├── Overview                              ← sync/streams/overview, was titled "Quickstart"; sync/overview deleted
├── Quickstart                            ← new page (sync/streams/quickstart)
├── Usage                                 ← new group
│   ├── Writing Queries                   ← now before Using Parameters
│   ├── Using Parameters
│   ├── Common Table Expressions (CTEs)
│   ├── Bucket Count
│   ├── Client-Side Usage
│   ├── Prioritized Sync                  ← moved from Advanced
│   └── Examples & Demos                  ← now after Client-Side Usage
├── Reference                             ← renamed from "Supported SQL"
│   ├── Supported SQL                     ← sidebar title was "Guide"
│   ├── Grammar Reference
│   └── Type Mapping                      ← moved from top level
├── Advanced
│   ├── Overview
│   ├── Reducing Buckets
│   ├── Client ID
│   ├── Case Sensitivity
│   ├── Compatibility
│   ├── Storage Version 4
│   ├── Sync Data by Time
│   ├── Schemas and Connections
│   ├── Multiple Client Versions
│   ├── Partitioned Tables (Postgres)
│   └── Sharded Databases
└── Sync Rules (Legacy)                   ← moved to the bottom
    ├── Migrate to Sync Streams           ← moved from Sync Streams section
    ├── Overview & Key Concepts
    ├── Organize Data Into Buckets
    ├── Global Buckets
    ├── Parameter Queries
    ├── Data Queries
    ├── Many-to-Many and Join Tables
    ├── Client Parameters
    └── Grammar Reference (Sync Rules)    ← moved from Supported SQL

This also updates the migration guide to conform to our writing and style standards (e.g. lessen offline-first framing), improved the flow into a clear "use the tool" step and then "adopt more Sync Streams functionality later" step, and added more practical examples.

Also see #655 for moving more sync rules content into the self-contained "Sync Rules (legacy)" section.

🤖 Claude Code helped implement most of these updates while I reviewed and polished manually.

@mintlify

mintlify Bot commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
powersync 🟢 Ready View Preview Sep 18, 2026, 2:59 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

Comment thread snippets/binary-type.mdx Outdated
Comment thread debugging/error-codes.mdx
Comment thread sync/advanced/overview.mdx Outdated
@benitav benitav changed the title New Sync Streams navigration New Sync Streams navigation Sep 15, 2026
@benitav
benitav marked this pull request as draft September 15, 2026 09:59
@benitav
benitav marked this pull request as ready for review September 16, 2026 11:23
@benitav
benitav requested a review from cahofmeyr September 16, 2026 11:24
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
Comment thread sync/rules/migrate-to-sync-streams.mdx Outdated
Comment thread sync/rules/migrate-to-sync-streams.mdx Outdated
Comment thread sync/rules/migrate-to-sync-streams.mdx
Comment thread snippets/binary-type.mdx
@claude

claude Bot commented Sep 16, 2026

Copy link
Copy Markdown
Contributor

Reviewed the added/modified content against the writing standards. Found a broken in-page anchor and a few technical-accuracy points needing verification (posted inline). Note: I couldn't run Vale or the Mintlify broken-links check in this environment, so those checks are still outstanding.

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.

1 participant