doc: add checkpoint docs.#784
Open
JackYPCOnline wants to merge 4 commits intostrands-agents:mainfrom
Open
Conversation
JackYPCOnline
had a problem deploying
to
auto-approve
GitHub Actions
Failure
JackYPCOnline
requested a deployment
to
manual-approval
GitHub Actions
Waiting
Contributor
Documentation Preview ReadyYour documentation preview has been successfully deployed! Preview URL: https://d3ehv1nix5p99z.cloudfront.net/pr-cms-784/docs/user-guide/quickstart/overview/ Updated at: 2026-04-29T19:28:19.229Z |
JackYPCOnline
temporarily deployed
to
auto-approve
GitHub Actions
Inactive
JackYPCOnline
requested a deployment
to
manual-approval
GitHub Actions
Waiting
JackYPCOnline
requested a deployment
to
manual-approval
GitHub Actions
Waiting
JackYPCOnline
temporarily deployed
to
auto-approve
GitHub Actions
Inactive
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.
Description
Adds a user-guide page for the experimental checkpointing feature at user-guide/concepts/experimental/checkpointing. The doc walks through the two cycle boundaries (after_model, after_tools), the checkpointResume resume pattern, crash recovery across fresh agent instances, and the interaction with interrupts and cancellation.
Sections:
Overview with a mermaid diagram of the full flow (including interrupt and cancel precedence)
Basic Usage — runnable example with checkpointing=True and a while loop driving resumes
Fresh Agent Instances — crash-recovery pattern across process boundaries
Limitations and Interrupts cross-reference
Structure mirrors the sibling interrupts.mdx (code → Components → Rules per use case). Also registers the new page in
navigation.yml
under Concepts → Experimental.
All claims were verified against the implementation in strands.experimental.checkpoint and event_loop.py, and the Basic Usage example was run end-to-end against Bedrock (Claude 3 Haiku) to confirm result.stop_reason and result.checkpoint behave as documented.
add checkpoint docs
Related Issues
Type of Change
Checklist
npm run devBy submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.