Skip to content

Fix copy-pasted titles and labels on SDK section index pages - #5155

Open
DABH wants to merge 2 commits into
mainfrom
docs/fix-sdk-section-page-titles
Open

Fix copy-pasted titles and labels on SDK section index pages#5155
DABH wants to merge 2 commits into
mainfrom
docs/fix-sdk-section-page-titles

Conversation

@DABH

@DABH DABH commented Aug 21, 2026

Copy link
Copy Markdown
Contributor

What

Frontmatter on docs/develop/<sdk>/<section>/index.mdx pages that was copied from another page and never updated.

File(s) Field Was Now
all 7 */platform/index.mdx title Client - <X> SDK Platform - <X> SDK
all 7 */platform/index.mdx sidebar_label Client Platform
typescript/activities title Workflows - TypeScript SDK Activities - TypeScript SDK
typescript/activities description "...implement Workers..." "...implement Activities..."
typescript/workflows description "...implement Workers..." "...implement Workflows..."
java/workers sidebar_label Nexus Workers
java/workflows sidebar_label Nexus Workflows

Why it matters (and where it doesn't)

sidebars.js sets an explicit label: on each of these categories, so the left nav was already correct and the sidebar_label values were inert — wrong, but invisible to readers. Fixed anyway so the next person to copy one of these files doesn't inherit it.

The title and description values were not inert. They drive the H1, the browser title, the OG card, and the search snippet. Verified in the built output before the fix:

build/develop/python/platform/index.html   <h1>Client - Python SDK

A reader clicking Platform in the sidebar landed on a page whose heading said Client. After:

python/platform          Platform - Python SDK
typescript/activities    Activities - TypeScript SDK
typescript/workflows     Workflows - TypeScript SDK
java/workers             Workers - Java SDK

How these were found

Not by eye — by scripted audit over all 68 docs/develop/**/index.mdx pages, comparing the leading noun of each title against its own directory name, and separately flagging any description naming a section other than its own. Both audits are clean after this change. The same audit is worth re-running after any future page-copy.

Checks

  • yarn build passes; H1s verified in the built HTML
  • vale --config .vale-ci.ini on all 11 changed files: 0 errors, 0 warnings, 0 suggestions
  • No URL, slug, or id changes, so no redirects needed

Not included

The 7 platform pages also share the description "This section explains how to implement platform with the <X> SDK" — grammatically odd and lowercase, but not factually wrong, so rewording it is a separate editorial change rather than a bug fix.

Found while investigating #5144.

An audit comparing each docs/develop/<sdk>/<section>/index.mdx against its
directory found frontmatter carried over from whichever page it was copied
from:

- All 7 platform/index.mdx pages were titled "Client - <X> SDK". The built
  page rendered "Client - Python SDK" as its H1 while the sidebar entry
  correctly read "Platform", so clicking Platform landed on a page titled
  Client.
- typescript/activities/index.mdx was titled "Workflows - TypeScript SDK".
- typescript/activities and typescript/workflows both described themselves
  as explaining "how to implement Workers".
- java/workers and java/workflows both set sidebar_label: Nexus.

sidebars.js sets an explicit label on these categories, so the left nav was
already right and only the sidebar_label values were inert. The titles and
descriptions were not: they drive the H1, the page title, the OG card, and
search snippets.
Copilot AI balanced review requested due to automatic review settings August 21, 2026 03:54
@DABH
DABH requested a review from a team as a code owner August 21, 2026 03:54
@vercel

vercel Bot commented Aug 21, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
temporal-documentation Ready Ready Preview Aug 21, 2026 4:07am

Request Review

@github-actions

github-actions Bot commented Aug 21, 2026

Copy link
Copy Markdown
Contributor

📖 Docs PR preview links

Copilot AI left a comment

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.

Pull request overview

Corrects stale SDK section frontmatter so page titles, descriptions, and labels match their sections.

Changes:

  • Renames seven Platform page titles and labels.
  • Corrects TypeScript Activities/Workflows metadata and Java sidebar labels.

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated no comments.

Show a summary per file
File Description
docs/develop/typescript/workflows/index.mdx Corrects the description.
docs/develop/typescript/platform/index.mdx Corrects Platform metadata.
docs/develop/typescript/activities/index.mdx Corrects Activities metadata.
docs/develop/ruby/platform/index.mdx Corrects Platform metadata.
docs/develop/python/platform/index.mdx Corrects Platform metadata.
docs/develop/php/platform/index.mdx Corrects Platform metadata.
docs/develop/java/workflows/index.mdx Corrects the sidebar label.
docs/develop/java/workers/index.mdx Corrects the sidebar label.
docs/develop/java/platform/index.mdx Corrects Platform metadata.
docs/develop/go/platform/index.mdx Corrects Platform metadata.
docs/develop/dotnet/platform/index.mdx Corrects Platform metadata.

💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

docs/develop/java/activities/timeouts.mdx described itself as explaining
"how to implement Workers". Widening the audit from index.mdx to every
page under docs/develop found it; the first pass only checked index pages.
@DABH

DABH commented Aug 21, 2026

Copy link
Copy Markdown
Contributor Author

Widened the audit and found a fourth instance, now fixed in this PR.

My first pass only scanned **/index.mdx, which was too narrow — the same copy-paste defect exists on a leaf page:

docs/develop/java/activities/timeouts.mdx described itself as "This section explains how to implement Workers with the Java SDK" on an Activity Timeouts page. It has been live since 8e508b879 and survived e9ace0b2a, which edited 8 lines of that very file without noticing.

Re-ran across every .mdx under docs/develop/ (not just index pages): clean now.

For anyone re-checking later, this is the audit — it flags a page whose description names a section other than the one it lives in:

for f in $(find docs/develop -name '*.mdx'); do
  d=$(awk '/^description:/{p=1;sub(/^description: */,"");if($0!="")print;next} p&&/^[a-zA-Z_]+:/{exit} p{print}' "$f" | tr '\n' ' ')
  sec=$(echo "${f#docs/develop/}" | cut -d/ -f2)
  for other in Workflows Activities Workers Client Nexus; do
    lo=$(echo "$other" | tr 'A-Z' 'a-z')
    [ "$(echo $sec | tr 'A-Z' 'a-z')" != "$lo" ] && echo "$d" | grep -qw "implement $other" && echo "$f"
  done
done

Worth noting what this defect class implies: every one of these pages' links is correct, because docusaurus.config.js sets onBrokenLinks: 'throw' so a bad link fails the build. The prose one-liners have no such check, and that is exactly where all four errors are.

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