Skip to content

feat: Add README documentation for cmd/samples/recipes#127

Draft
zawadzkidiana wants to merge 8 commits intocadence-workflow:masterfrom
zawadzkidiana:migrate-cmd-samples
Draft

feat: Add README documentation for cmd/samples/recipes#127
zawadzkidiana wants to merge 8 commits intocadence-workflow:masterfrom
zawadzkidiana:migrate-cmd-samples

Conversation

@zawadzkidiana
Copy link
Copy Markdown
Contributor

@zawadzkidiana zawadzkidiana commented Dec 2, 2025

Summary

Added README documentation to all recipe samples in cmd/samples/recipes/ to improve discoverability and onboarding for new developers.

See code here: https://github.com/zawadzkidiana/cadence-samples/tree/migrate-cmd-samples

Changes

  • Added 16 new READMEs covering:
    • Basic: helloworld, greetings, timer, delaystart
    • Parallel: branch, splitmerge, pickfirst
    • Control flow: choice, childworkflow, dynamic
    • Signals: signalcounter
    • Operations: cancelactivity, retryactivity
    • Advanced: sideeffect, crossdomain, tracing

Each README includes:

  • ASCII diagram showing the workflow pattern
  • Prerequisites and running instructions
  • Key code snippets
  • Links to visual tutorial in new_samples/hello_world

Testing
Verified sample commands work on local environment.

Signed-off-by: Diana Zawadzki <dzawa@live.de>
Signed-off-by: Diana Zawadzki <dzawa@live.de>
Signed-off-by: Diana Zawadzki <dzawa@live.de>
Signed-off-by: Diana Zawadzki <dzawa@live.de>
Signed-off-by: Diana Zawadzki <dzawa@live.de>
Signed-off-by: Diana Zawadzki <dzawa@live.de>
Signed-off-by: Diana Zawadzki <dzawa@live.de>
Signed-off-by: Diana Zawadzki <dzawa@live.de>
@zawadzkidiana zawadzkidiana self-assigned this Dec 2, 2025
@zawadzkidiana zawadzkidiana marked this pull request as draft December 2, 2025 22:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant