Draft
Conversation
Docs preview deploy✅ Successfully deployed docs preview for commit 652c5c2: https://edgedb-docs-plhpvdbul-edgedb.vercel.app (Last updated: Sep 8, 2025, 16:46:20 UTC) |
aljazerzen
approved these changes
Oct 3, 2025
Contributor
aljazerzen
left a comment
There was a problem hiding this comment.
As someone who did not know exactly how sync worked prior to reading this, I can say it explains the method well.
The first 2 or 3 sections are very understandable and the last 3 are details to the degree that I'd skip them until I actually needed them.
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.
I've tried different ways of writing up the details of how
syncworks. This is the format I've kinda landed on eventually:I also ended up not using code snippets because that seemed to me like a lot of noise that was getting in the way of keeping explanations simple. Plus we have plenty of code examples elsewhere (like primers) that we could link to instead.