Skip to content

Conversation

@zawadzkidiana
Copy link
Contributor

@zawadzkidiana zawadzkidiana commented Dec 1, 2025

Summary
Improved documentation clarity across cadence-samples to reduce onboarding friction for new developers.

Find code changes here: https://github.com/zawadzkidiana/cadence-samples/tree/walkthrough/new_samples/hello_world

Changes

Documentation fixes

  • Fixed CLI command syntax in walkthrough (workflow list instead of --workflow list)
  • Added Docker troubleshooting section to main README for common setup issues

Visual walkthrough

  • Added step-by-step screenshots to hello_world README
  • Shows expected terminal output and Cadence Web UI at each step

Code clarity

  • Simplified signal workflow naming for better discoverability

Testing
Verified walkthrough end-to-end on local environment.

@zawadzkidiana zawadzkidiana self-assigned this Dec 1, 2025
@zawadzkidiana zawadzkidiana marked this pull request as draft December 1, 2025 18:44
@zawadzkidiana
Copy link
Contributor Author

Initial PR draft; want to review walkthrough another time to ensure all commands are correct and the setup feels intuitive.

@zawadzkidiana
Copy link
Contributor Author

Note: Also modified the config.yaml to route into "cadence-samples" project.

config for sample

domain: "default"
domain: "cadence-samples"

Copy link
Member

@demirkayaender demirkayaender left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for starting a great new sample series!

@zawadzkidiana zawadzkidiana marked this pull request as ready for review December 2, 2025 00:23
@zawadzkidiana zawadzkidiana merged commit 2fd7776 into cadence-workflow:master Dec 2, 2025
3 checks passed
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.

2 participants