docs: slim AGENTS.md to defer to the developer guide#538
Merged
Conversation
The file duplicated API reference, testing, patterns, and IaC content that the AWS Durable Execution SDK Developer Guide now owns. Duplicated examples drift from the released API. The wait_for_callback examples showed a one-argument submitter, which raises TypeError against the current SDK, and imported WaitForCallbackConfig from the wrong module. Replace the duplicated content with links to the developer guide and keep only what is repo-specific: the replay-model rules in prose, the package layout, and the hatch-based contribution workflow.
ParidelPooya
approved these changes
Jul 14, 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
2 participants
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
AGENTS.md duplicated a large amount of API reference, testing, pattern, and IaC content that the AWS Durable Execution SDK Developer Guide now owns. Duplicated examples drift from the released API, and AI coding assistants pick this file up automatically, so drift here propagates directly into user code. Two concrete examples of drift in the removed content:
wait_for_callbackexamples showed a one-argument submitter. The SDK invokes the submitter with two positional arguments (callback_id,WaitForCallbackContext), so the example raisesTypeErrorat runtime.WaitForCallbackConfigfromaws_durable_execution_sdk_python.waitsinstead ofaws_durable_execution_sdk_python.config.This change cuts the file from 929 lines to 69 and defers to the developer guide for all signatures and examples. It keeps only what is repo-specific:
Testing
Markdown-only change. All developer guide links verified against the published site.