Skip to content

workflow section audit - #5297

Open
jsundai wants to merge 3 commits into
mainfrom
workflow-sdk-review
Open

workflow section audit#5297
jsundai wants to merge 3 commits into
mainfrom
workflow-sdk-review

Conversation

@jsundai

@jsundai jsundai commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

What does this PR do?

  • Headings: dropped "How to" across 23 files so all SDKs use verb-first headings for the same content. Anchors preserved, and the 37 on-page contents bullets pointing at renamed headings updated to match.
    timeouts.mdx: all eight pages now use "Workflow timeouts" and "Workflow retries" at the same heading level.
  • Descriptions: rewrote 15. Eight ran 176 to 299 characters against a 120 to 155 target, and the TypeScript cancellation and cancellation-scopes pages had each other's.
  • Tags: .Net SDK and .NET SDK were splitting the tag index in two, now standardized. Added the missing Workflows tag to 25 pages.
  • Prose: removed the intensifiers and filler the style guide names, mostly boilerplate repeated across all eight SDKs.
  • Bug fixes: PHP basics had a sentence restarting mid-clause, literal ** rendering on the page, and a DataConverter link to the Java javadoc. TypeScript timeouts had a sample that throws on an undefined CustomError, plus ApplicationError for ApplicationFailure and non_retryable for nonRetryable. Fixed 25 "Typescript" misspellings including four titles.

Notes to reviewers

@jsundai
jsundai requested a review from a team as a code owner September 10, 2026 15:53
@vercel

vercel Bot commented Sep 10, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
temporal-documentation Ready Ready Preview Sep 10, 2026 4:50pm UTC

Request Review

It is a powerful method for introducing compatible changes without introducing non-determinism errors.
It introduces compatible changes without causing non-determinism errors.

### Detailed Overview of the Patched Function

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

📝 [vale] <Temporal.Headings> reported by reviewdog 🐶
'Detailed Overview of the Patched Function' should use sentence-style capitalization.

It is a powerful method for introducing compatible changes without introducing non-determinism errors.
It introduces compatible changes without causing non-determinism errors.

### Detailed Description of the Patched Function

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

📝 [vale] <Temporal.Headings> reported by reviewdog 🐶
'Detailed Description of the Patched Function' should use sentence-style capitalization.

@github-actions

github-actions Bot commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 9e388643cf

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread docs/develop/go/workflows/timeouts.mdx Outdated
Comment on lines +22 to +23
Avoid setting Workflow Timeouts. Workflows are designed to be long-running and resilient, and a Timeout limits a Workflow's ability to handle unexpected delays or long-running processes.
To perform an action inside your Workflow after a specific period of time, use a Timer instead.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Apply the timeout rewrite to the concept page

The same three-sentence timeout guidance remains unchanged in docs/encyclopedia/detecting-workflow-failures.mdx:17-19, so readers of the main concept page still get the filler-heavy wording removed from the SDK pages. Apply this concise rewrite there as well to keep the shared guidance consistent.

AGENTS.md reference: AGENTS.md:L236-L240

Useful? React with 👍 / 👎.

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