docs: align agent and flow durability guarantees - #4907
Open
be-student wants to merge 1 commit into
Open
Conversation
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
1 participant
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.
Closes #4846.
The README implied that conversation memory resumes interrupted execution, while the durable execution design note still described shipped features as unimplemented. Add a source-linked durability contract and align the README, roadmaps, workflow/loop guides, and durable examples with it.
The guide distinguishes memory, flow checkpoints, opt-in agent checkpoints, and tracing; documents saved-stage recovery, waiting/input, retry inheritance, tool-result deduplication, and explicit resume; and identifies the limits around storage failures, repeated side effects, and concurrent recovery. The historical proposal remains available with a clear status banner. Remaining architectural work links to #4816.
Validation (Go 1.25.12):
go build ./...andgo test ./...: passed.go test ./agent ./flow: passed.make harness: passed, including mock provider conformance (6 passed).go run ./examples/agent-durable: passed; resumed with one tool execution.git diff --check: passed.golangci-lint run ./...(v2.5.0): reports 8 existing findings in unchanged Go files: two unchecked watcher errors and six spelling findings in AI code/tests. No Go source, dependency, or lint configuration changes are included.The documented no-secret checks use controlled models/stores and simulated interruption; they do not claim real process-kill or production-backend recovery coverage. This documentation audit was implemented and validated by Codex.