structure standardization workflow basics - #5222
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| built-in logger and tracing interceptors use internally. | ||
|
|
||
| ### .NET Task Determinism | ||
| ## .NET Task Determinism |
There was a problem hiding this comment.
📝 [vale] <Temporal.Headings> reported by reviewdog 🐶
'.NET Task Determinism' should use sentence-style capitalization.
📖 Docs PR preview links
|
There was a problem hiding this comment.
🟡 Changes recommended
The Ruby and .NET structures remain incomplete, Rust exceeds the heading target, and TypeScript incorrectly promises Workflow Type customization.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Standardizes Workflow basics documentation across eight SDKs.
Changes:
- Aligns headings, anchors, and frontmatter descriptions.
- Promotes major topics in the page hierarchy.
- Updates the Go Workflow Type link.
File summaries
| File | Description |
|---|---|
docs/develop/dotnet/workflows/basics.mdx |
Reorganizes Workflow sections. |
docs/develop/go/workflows/basics.mdx |
Standardizes headings and anchors. |
docs/develop/go/client/temporal-client.mdx |
Updates the Workflow Type anchor. |
docs/develop/java/workflows/basics.mdx |
Standardizes headings and description. |
docs/develop/php/workflows/basics.mdx |
Standardizes headings and frontmatter. |
docs/develop/python/workflows/basics.mdx |
Aligns title and section hierarchy. |
docs/develop/ruby/workflows/basics.mdx |
Promotes selected Workflow sections. |
docs/develop/rust/workflows/basics.mdx |
Restructures Workflow topic headings. |
docs/develop/typescript/workflows/basics.mdx |
Standardizes headings and removes the explicit slug. |
Review details
Suppressed comments (1)
docs/develop/typescript/workflows/basics.mdx:94
- This heading says users can customize the Workflow Type, but the section explains that TypeScript provides no customization mechanism. Rename the section and remove the contradictory setup sentence so the heading matches the documented behavior.
## Customize Workflow Type {/* #workflow-type */}
- Files reviewed: 9/9 changed files
- Comments generated: 4
- Review effort level: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| All Workflow Definition parameters must be serializable. | ||
|
|
||
| ### Use Workflow constructors | ||
| ## Customize Workflow Type {/* #workflow-type */} |
| However, we strongly recommend that hashes or objects are used as parameters, so that the object's individual fields may be altered without breaking the signature of the Workflow. | ||
|
|
||
| ### Customize Workflow Type {/* #workflow-type */} | ||
| ## Customize Workflow Type {/* #workflow-type */} |
| ## Workflow struct {/* #workflow-struct */} | ||
|
|
||
| The Workflow struct holds the state of your Workflow Execution. This state is persisted and recovered during replays. All fields in a Workflow struct should be serializable. | ||
|
|
||
| ### Workflow initialization {/* #init-method */} | ||
| ## Workflow initialization {/* #init-method */} |
There was a problem hiding this comment.
Changed “Workflow struct” and “Workflow initialization” to level-three headings under “Develop a basic Workflow.” Commit: 22eb0f0.
| id: basics | ||
| title: Workflow basics - TypeScript SDK | ||
| description: Shows how to create a Workflow with the TypeScript SDK | ||
| description: Develop a basic Workflow with the Temporal TypeScript SDK. Define Workflow parameters, return values, and a custom Workflow Type. |
Co-authored-by: jsundai <36107423+jsundai@users.noreply.github.com>
|
|
What does this PR do?
Notes to reviewers