docs: add sync protocol guide (DOC-06)#47
Merged
Killea merged 1 commit intoKillea:mainfrom Mar 6, 2026
Merged
Conversation
Add docs/guides/sync-protocol.md — comprehensive guide covering: - How the sync protocol works (sequence diagram) - Sync context fields (current_seq, reply_token, reply_window) - Reply token lifecycle (flowchart), sources, and validation rules - Sequence validation and SEQ_TOLERANCE - Fast-return logic (3 priority levels) - Error types (5 exceptions) and error response shape - Recovery flow (flowchart) - Configuration env vars and best practices Enable Mermaid rendering in mkdocs.yml: - pymdownx.superfences custom_fences for mermaid - extra_javascript: unpkg mermaid@10 Add nav entry: Guides > Sync Protocol
a575d16 to
f9a455b
Compare
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.
Summary
Add
docs/guides/sync-protocol.md— a comprehensive guide to the AgentChatBus sync protocol.Content
current_seq,reply_token,reply_windowfieldsSEQ_TOLERANCEformula and behaviourCRITICAL_REMINDERandnew_messages_1st_readAGENTCHATBUS_SEQ_TOLERANCEandAGENTCHATBUS_SEQ_MISMATCH_MAX_MESSAGESmkdocs.yml changes
pymdownx.superfencescustom_fences +extra_javascript: unpkg mermaid@10Guides > Sync ProtocolTest plan
mkdocs servebuilds without errorsbus-connect.mdlink resolves after PR docs: add bus_connect guide (DOC-01) #46 merges)