New Sync Streams navigration - #640
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
| @@ -1,3 +1,3 @@ | |||
| <Note> | |||
| Binary data can be accessed in the Sync Streams / Sync Rules, but cannot be used as [parameters](/sync/overview#how-it-works). To sync binary columns/fields to clients, those columns need to be converted to hex or base64 representation using the relevant [functions](/sync/supported-sql#functions). | |||
| Binary data can be accessed in Sync Streams, but cannot be used as [parameters](/sync/streams/parameters). To sync binary columns/fields to clients, those columns need to be converted to hex or base64 representation using the relevant [functions](/sync/supported-sql#functions). | |||
There was a problem hiding this comment.
This snippet is also included on sync/types.mdx, a page that still serves legacy Sync Rules users (type mapping applies to both). Dropping the Sync Rules mention and pointing "parameters" only at /sync/streams/parameters means Sync Rules readers lose an accurate cross-reference (Sync Rules parameters work differently, via client parameters). Consider keeping a Sync Rules mention here, e.g. "Binary data can be accessed in Sync Streams (or legacy Sync Rules), but cannot be used as parameters," with a link that covers both, or two links.
| Binary data can be accessed in Sync Streams, but cannot be used as [parameters](/sync/streams/parameters). To sync binary columns/fields to clients, those columns need to be converted to hex or base64 representation using the relevant [functions](/sync/supported-sql#functions). | |
| Binary data can be accessed in Sync Streams (or legacy Sync Rules), but cannot be used as a parameter (see [Sync Streams parameters](/sync/streams/parameters) or [Sync Rules client parameters](/sync/rules/client-parameters)). To sync binary columns/fields to clients, those columns need to be converted to hex or base64 representation using the relevant [functions](/sync/supported-sql#functions). |
|
|
||
| - **PSYNC_R0001**: | ||
| Catch-all [Sync Config](/sync/overview) parsing error, if no more specific error is available | ||
| Catch-all [Sync Config](/sync/streams/quickstart#defining-streams) parsing error, if no more specific error is available |
There was a problem hiding this comment.
This error code is a catch-all for "Sync Config" parsing, which still covers legacy Sync Rules configs too (see the many generic "Sync Config" mentions elsewhere on this page). Linking "Sync Config" to the Sync-Streams-only Quickstart section sends Sync Rules readers hitting this error to content that doesn't apply to their config format. Consider linking to a page/section that covers Sync Config generally, or to the Sync Streams and Sync Rules overview pages separately.
| --- | ||
| title: "Advanced Topics" | ||
| description: "Advanced Sync Streams and Sync Rules topics." | ||
| description: "Advanced Sync Streams topics." |
There was a problem hiding this comment.
This description now says these are Sync Streams-only topics, but several pages linked from this index (prioritized-sync, sync-data-by-time, partitioned-tables, sharded-databases, multiple-client-versions, compatibility, case-sensitivity) still document legacy Sync Rules behavior in depth, including parallel "Sync Rules (Legacy)" tabs. Consider restoring a mention of Sync Rules here so the description matches the actual page content.
1 participant
Focus the current "Sync Streams/Rules" section in the sidebar on Sync Streams only, move Sync Rules content into the "Sync Rules (legacy)" section.