docs(backend): align auth and sync behavior documentation#1574
Merged
tyler-dane merged 1 commit intomainfrom Mar 27, 2026
Merged
docs(backend): align auth and sync behavior documentation#1574tyler-dane merged 1 commit intomainfrom
tyler-dane merged 1 commit intomainfrom
Conversation
Co-authored-by: Tyler Dane <tyler-dane@users.noreply.github.com>
tyler-dane
approved these changes
Mar 27, 2026
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
docs/backend/README.mdfrom a status note into a backend orientation page with intent, source anchors, workflow summaries, and operational constraints.docs/backend/api-documentation.mdto document:POST /api/signoutlogout cleanup semantics (handleLogoutCleanup, metadata restart behavior, last-session watch teardown, non-blocking cleanup failures)POST /api/sync/import-gcalrequest body contract ({ force?: boolean }) and force/no-force guardrail behavior.docs/features/google-sync-and-websocket-flow.mdwith:Codepaths covered
packages/backend/src/common/middleware/supertokens.middleware.handlers.tspackages/backend/src/user/services/user.service.tspackages/backend/src/sync/controllers/sync.controller.tspackages/backend/src/sync/sync.types.tspackages/backend/src/sync/services/sync.service.tspackages/backend/src/sync/sync.routes.config.tsKnowledge gaps addressed
/api/sync/import-gcaland whatforcechanges.Note
Low Risk
Documentation-only updates; low risk aside from potential confusion if the described auth/sync semantics diverge from runtime behavior.
Overview
Expands
docs/backend/README.mdinto an orientation page with intent, key source anchors, and concise descriptions of core workflows (auth/session, event writes, Google notification ingress) plus operational notes.Updates backend docs to explicitly document
POST /api/signoutcleanup semantics (non-blockinghandleLogoutCleanup, metadataRESTART, and last-session watch teardown) and thePOST /api/sync/import-gcalrequest-body contract ({ force?: boolean }) and guardrails.Adds corresponding sections to
docs/features/google-sync-and-websocket-flow.mddescribing logout watch teardown and the manual import trigger contract + asynchronous websocket progress events.Written by Cursor Bugbot for commit da3f57d. This will update automatically on new commits. Configure here.