Skip to content

Commit 611eb55

Browse files
committed
docs: drop in-repo docs, use aws docs site
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.
1 parent 85f2d24 commit 611eb55

22 files changed

Lines changed: 5 additions & 11380 deletions

AGENTS.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -926,9 +926,4 @@ Resources:
926926
**Python SDK:**
927927
928928
- [SDK Repository](https://github.com/aws/aws-durable-execution-sdk-python)
929-
- [Documentation Index](https://github.com/aws/aws-durable-execution-sdk-python/blob/main/docs/index.md)
930-
- [Getting Started](https://github.com/aws/aws-durable-execution-sdk-python/blob/main/docs/getting-started.md)
931-
- [Steps](https://github.com/aws/aws-durable-execution-sdk-python/blob/main/docs/core/steps.md)
932-
- [Wait Operations](https://github.com/aws/aws-durable-execution-sdk-python/blob/main/docs/core/wait.md)
933-
- [Callbacks](https://github.com/aws/aws-durable-execution-sdk-python/blob/main/docs/core/callbacks.md)
934-
- [Testing Patterns](https://github.com/aws/aws-durable-execution-sdk-python/blob/main/docs/testing-patterns/basic-tests.md)
929+
- [AWS Durable Execution Documentation](https://docs.aws.amazon.com/durable-execution/)

README.md

Lines changed: 4 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -68,33 +68,10 @@ def handler(event: dict, context: DurableContext) -> dict:
6868

6969
## 📚 Documentation
7070

71-
- **[AWS Documentation](https://docs.aws.amazon.com/lambda/latest/dg/durable-functions.html)** - Official AWS Lambda durable functions guide
72-
- **[Documentation index](docs/index.md)** - SDK Overview and navigation
73-
74-
**New to durable functions?**
75-
- [Getting started guide](docs/getting-started.md) - Build your first durable function
76-
77-
**Core operations:**
78-
- [Steps](docs/core/steps.md) - Execute code with automatic checkpointing and retry support
79-
- [Wait operations](docs/core/wait.md) - Pause execution without blocking Lambda resources
80-
- [Callbacks](docs/core/callbacks.md) - Wait for external systems to respond
81-
- [Invoke operations](docs/core/invoke.md) - Call other durable functions and compose workflows
82-
- [Child contexts](docs/core/child-contexts.md) - Organize complex workflows into isolated units
83-
- [Parallel operations](docs/core/parallel.md) - Run multiple operations concurrently
84-
- [Map operations](docs/core/map.md) - Process collections in parallel with batching
85-
- [Logger integration](docs/core/logger.md) - Add structured logging to track execution
86-
87-
**Advanced topics:**
88-
- [Error handling](docs/advanced/error-handling.md) - Handle failures and implement retry strategies
89-
- [Testing modes](docs/advanced/testing-modes.md) - Run tests locally or against deployed Lambda functions
90-
- [Testing patterns](docs/testing-patterns/basic-tests.md) - Practical testing examples
91-
- [Serialization](docs/advanced/serialization.md) - Customize how data is serialized in checkpoints
92-
93-
**Architecture:**
94-
- [Architecture diagrams](docs/architecture.md) - Class diagrams and concurrency flows
95-
96-
**API reference:**
97-
- API reference docs are in progress. Use the core operation docs above for now.
71+
The complete documentation for the AWS Durable Execution SDK for Python lives on the AWS Documentation site:
72+
73+
- **[AWS Durable Execution Documentation](https://docs.aws.amazon.com/durable-execution/)** - Concepts, getting started, core operations, advanced topics, and API reference
74+
- **[AWS Lambda Durable Functions Guide](https://docs.aws.amazon.com/lambda/latest/dg/durable-functions.html)** - How durable functions work on Lambda
9875

9976
## 💬 Feedback & Support
10077

0 commit comments

Comments
 (0)