Conversation
benitav
added this pull request to stack #656
September 18, 2026 16:18
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
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.
Stacked on #640, merge that one first.
This PR mostly contains structural/navigational updates so that the Sync Streams and Sync Rules docs are more self-contained. I also fixed some existing inconsistencies and polished things along the way. The below summary was generated by Claude:
Sync Rules are deprecated, so this PR separates the two engines in the docs. The Sync Streams section reads as if Sync Rules never existed, and the Sync Rules (Legacy) section has everything a Sync Rules user still needs while they migrate.
Split pages: pages that covered both engines are now one Sync Streams page and one Sync Rules page under
sync/rules/.Shared pages: pages that apply to both engines keep one body in
snippets/sync-shared/, with engine-neutral wording, rendered by a wrapper page in each section.Sync Streams only: these Advanced topics are newer guides and functionality written for Sync Streams, so they get no Sync Rules version.
Counterpart comments: every split page, wrapper, and shared snippet starts with an MDX comment naming its counterpart, so future edits consider both sides.
Sync Rules pages:
sync/rules/opens with a deprecation callout, except the migration guide itself. Split pages link to their Sync Streams version, concept pages to the closest Sync Streams equivalent, and shared pages state that they apply to both engines./sync/rules/supported-sqlis removed because that page exists again.Sync Streams pages: no longer mention Sync Rules, with one exception. Storage Version 4 states that incremental reprocessing is not supported for Sync Rules.
Tooling:
pnpm check:linksnow runsscripts/check-links.mjs, which wraps the Mintlify checks and resolves anchors defined in imported snippets. CI runs the same command..claude/are updated: new docs cover Sync Streams, Sync Rules docs stay accurate without being prioritized, and the two engines are never shown side by side.Worth a look on the preview: the shared pages in both sections (the Type Mapping pages import a nested snippet), and sidebar highlighting on those pages.
🤖 The updates were made by Claude Code, and it also generated the above summary. I had Claude review all changes in the PR multiple times against the review harness, and made it verify accuracy against the source code. I manually checked the structure and reviewed files on a high level (since these were mostly structural changes).