Repository navigation
Document the single-argument Workflow input recommendation - #5450
Merged
Merged
Conversation
Add a Workflow parameters section to the Workflow Definition page with the reasons to use one object parameter. Say 'single' in the TypeScript, .NET, and Ruby Workflow parameter guidance, and link the Web UI note to it.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
📖 Docs PR preview links
|
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
Existing Go, Python, Java, PHP, and Rust guidance still needs links to the new canonical rationale.
1 open finding
What changed in this PR
Adds centralized guidance recommending a single object parameter for Workflows and links SDK and Web UI documentation to it.
Changes:
- Explains the compatibility, type-safety, and Web UI benefits.
- Clarifies TypeScript, .NET, and Ruby recommendations.
- Connects Web UI guidance to the canonical section.
| File | Description |
|---|---|
docs/web-ui.mdx |
Links Web UI input guidance to the recommendation. |
docs/encyclopedia/workflow/workflow-definition.mdx |
Adds the canonical Workflow parameters guidance. |
docs/develop/typescript/workflows/basics.mdx |
Recommends one object parameter. |
docs/develop/ruby/workflows/basics.mdx |
Recommends one hash or object parameter. |
docs/develop/dotnet/workflows/basics.mdx |
Recommends one class parameter. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.
Duncanma
enabled auto-merge (squash)
October 7, 2026 22:48
lennessyy
approved these changes
Oct 7, 2026
lennessyy
left a comment
lennessyy
left a comment
Contributor
There was a problem hiding this comment.
Instead of "For more reasons", maybe just say "for more details?" I feel like "for more reasons" sounds slightly awkward
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Most SDK pages already recommend a single object parameter for Workflows, but the guidance was inconsistent and nowhere explained why.
Define Workflow parametersheading to .NET and Ruby, and link all three to the new section.Notes for review
Checks
vale --config .vale-ci.iniis clean on the touched files.yarn buildoryarn check-linkslocally.