docs: drop in-repo docs, use aws docs site#392
Merged
Conversation
The /docs folder is fully superseded by the AWS documentation site at https://docs.aws.amazon.com/durable-execution/. Remove it and point README.md and AGENTS.md at the AWS docs instead. - Delete docs/ and all subpages (index, getting-started, core/*, advanced/*, testing-patterns/*, architecture). - README.md: replace the Documentation section with links to the AWS docs site and the Lambda Durable Functions Guide. - AGENTS.md: in the "Python SDK:" link list, replace per-page docs/ links with a single link to the AWS docs site.
dhegberg
approved these changes
May 13, 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
The in-repo
/docsfolder is fully superseded by the AWS documentation site at https://docs.aws.amazon.com/durable-execution/. This PR deletes the folder and repoints the only two places in the repo that linked into it (README.mdandAGENTS.md) at the AWS docs.Changes
docs/and all subpages:docs/index.md,docs/getting-started.md,docs/architecture.md,docs/best-practices.mddocs/core/{steps,wait,callbacks,invoke,child-contexts,parallel,map,logger}.mddocs/advanced/{error-handling,testing-modes,serialization}.mddocs/testing-patterns/{basic-tests,complex-workflows,stores}.md.gitkeepfiles underdocs/api-reference/anddocs/testing-patterns/.README.md— replace the multi-section Documentation block with short links to:AGENTS.md— in the Python SDK link list, replace the per-pagegithub.com/.../blob/main/docs/...links with a single link to the AWS docs site. Other external links (AWS docs, JS SDK repo, etc.) are untouched.Sweep for other references
Grepped the full repo for
docs/,\bdocs\b, and each deleted filename:src/,tests/,examples/,.github/workflows/,.github/scripts/,.github/ISSUE_TEMPLATE/,pyproject.toml,.gitignore,CODE_OF_CONDUCT.md,NOTICE,LICENSE.docs.aws.amazon.com,docs.github.com,docs.astral.sh,github.com/ossf/scorecard/blob/main/docs/...) or thedocs:Conventional Commit prefix inCONTRIBUTING.mdand.github/scripts/lintcommit.py— all unrelated and left as-is.Validation
hatch fmt --check— clean (180 files already formatted).hatch run python .github/scripts/lintcommit.py— PASS on this commit.hatch run test:cov/hatch run types:check— not rerun locally (local env issue on this host's pyenv 3.14.5 install); this PR touches only markdown, so no Python code paths, tests, or type stubs are affected. CI will be the source of truth.