Skip to content

rewrite step docs#113

Merged
yaythomas merged 1 commit intomainfrom
steps
Apr 2, 2026
Merged

rewrite step docs#113
yaythomas merged 1 commit intomainfrom
steps

Conversation

@yaythomas
Copy link
Copy Markdown
Contributor

@yaythomas yaythomas commented Apr 2, 2026

Reviewer notes: meaningful changes are in step and a paragraph in basic concepts. the rest is placeholder and have issues to track improvement (e.g retries and testing)

Description of changes:

  • Rewrite step.md as concise reference doc, replacing FAQ/ToC structure with direct API reference format
  • Move all step examples from core/steps to operations/steps and testing examples to testing-patterns/basic-tests across all three languages; verify all samples against SDK source
  • Add Java examples for all step and testing-patterns sections
  • Add passing-data-wrong and passing-data-correct examples in all three languages showing mutation-lost-on-replay anti-pattern using register-user/wait/send-follow-up-email flow
  • Update retries.md, basic-tests.md, key-concepts.md
  • Run mdformat on updated doc files

Issue #, if available:
closes #40, closes #76, closes #58

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

- Rewrite step.md as concise reference doc, replacing FAQ/ToC
  structure with direct API reference format
- Move all step examples from core/steps to operations/steps and
  testing examples to testing-patterns/basic-tests across all
  three languages; verify all samples against SDK source
- Add Java examples for all step and testing-patterns sections
- Add passing-data-wrong and passing-data-correct examples in all
  three languages showing mutation-lost-on-replay anti-pattern
  using register-user/wait/send-follow-up-email flow
- Update retries.md, basic-tests.md, key-concepts.md
- Run mdformat on updated doc files

closes #40, closes #76, closes #58
@yaythomas yaythomas merged commit 816162b into main Apr 2, 2026
2 checks passed
@github-project-automation github-project-automation bot moved this from In review to Done in aws-durable-execution Apr 2, 2026
@yaythomas yaythomas deleted the steps branch April 2, 2026 22:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

2 participants