Skip to content

Docs: Add documentation for AWS Durable Execution SDK Python #136

@leandrodamascena

Description

@leandrodamascena

Description

The AWS Durable Execution SDK Python needs proper documentation. Developers need a clear guide on how to write and test their durable functions. This documentation will help them to adopt and use the framework effectively.

What we'll build

Documentation organized into four areas:

Core features - Installation, getting started, and detailed guides for steps, waits, callbacks, child contexts, parallel operations, map operations, and logging.

Advanced topics - Error handling and best practices.

Testing patterns - Examples showing how to test simple and complex workflows, plus best practices.

API reference - Review docstring to better describe method/classes and - if possible - create documentation for all classes, methods, and types.

These sections are subject to change as we carry out the work.

Sub-issues

To make review easier and reduce cognitive load, each documentation file will have its own focused issue. Check the linked issues below for specific tasks.

cc @bchampp

Sub-issues

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions