Repository navigation
docs: make package READMEs lean and usage-first - #914
Merged
Merged
Conversation
Rewrite the core, extras, microvm-worker, and testing READMEs. Each README now has install, a quick start, common uses, short advanced notes, and links to reference docs. Move the long sections to docs files next to each package: - core: docs/plugins.md - extras: docs/microvm.md - microvm-worker: docs/worker.md - testing: callback-failure notes into docs/error-responses.md Point the 2.x to 3.0 migration guide links at docs/plugins.md. Update the extras subtypes note: the core SDK now accepts a custom sub_type. Replace the deprecated run(timeout=...) in the testing example with execution_timeout.
hln33
approved these changes
Nov 9, 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.
What changed
Four package READMEs now follow one shape: install, a quick start, common uses, short advanced notes, and reference links. The long sections moved to docs files next to each package. Moved text keeps its wording.
aws-durable-execution-sdk-pythonaws-durable-execution-sdk-python-extrasaws-durable-execution-sdk-python-microvm-workeraws-durable-execution-sdk-python-testingThe testing README was already short. Most of what remains is code.
PyPI uses each README as the package description. So README links to repo files use absolute GitHub URLs.
Where the moved content went
packages/aws-durable-execution-sdk-python/docs/plugins.md. These cover the factory contract, OpenTelemetry views, the invocation worker lifecycle, and chained-invoke propagation. The two links fromdocs/migration-2.x-to-3.0.mdnow point at that file.packages/aws-durable-execution-sdk-python-extras/docs/microvm.md. This covers delivery, errors, retry tiers, limits, permissions, sessions, suspending, the state check, subtypes, and best practices. Keeping it in one file keeps every internal anchor valid.packages/aws-durable-execution-sdk-python-microvm-worker/docs/worker.md.packages/aws-durable-execution-sdk-python-testing/docs/error-responses.md.The READMEs keep the MicroVM rules below as product behavior:
ResumeMicrovm.idlePolicy.autoResumeEnabled. Setting it is the developer's job.maxIdleDurationSecondsabovemaximumDurationInSeconds.suspend_after, the developer is responsible for parallel operations on the same session.Fixed or dropped as stale
sub_typeonStepConfig,ChildConfig, andCallbackConfig. The note now says that this package does not set it yet.runner.run(..., timeout=10)emits aDeprecationWarning. The example now usesexecution_timeout.hatchtl;dr were dropped. The Reference section links to the contributing guide.How the examples were checked
DurableFunctionTestRunner, with DeprecationWarning set to error.hatch buildran for the four packages, andtwine checkpassed on the wheels and sdists.lintcommit.pypassed.