Fix copy-pasted titles and labels on SDK section index pages - #5155
Conversation
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.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
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.
|
Widened the audit and found a fourth instance, now fixed in this PR. My first pass only scanned
Re-ran across every For anyone re-checking later, this is the audit — it flags a page whose 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
doneWorth noting what this defect class implies: every one of these pages' links is correct, because |
What
Frontmatter on
docs/develop/<sdk>/<section>/index.mdxpages that was copied from another page and never updated.*/platform/index.mdxtitleClient - <X> SDKPlatform - <X> SDK*/platform/index.mdxsidebar_labelClientPlatformtypescript/activitiestitleWorkflows - TypeScript SDKActivities - TypeScript SDKtypescript/activitiesdescriptiontypescript/workflowsdescriptionjava/workerssidebar_labelNexusWorkersjava/workflowssidebar_labelNexusWorkflowsWhy it matters (and where it doesn't)
sidebars.jssets an explicitlabel:on each of these categories, so the left nav was already correct and thesidebar_labelvalues were inert — wrong, but invisible to readers. Fixed anyway so the next person to copy one of these files doesn't inherit it.The
titleanddescriptionvalues 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:A reader clicking Platform in the sidebar landed on a page whose heading said Client. After:
How these were found
Not by eye — by scripted audit over all 68
docs/develop/**/index.mdxpages, comparing the leading noun of eachtitleagainst its own directory name, and separately flagging anydescriptionnaming 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 buildpasses; H1s verified in the built HTMLvale --config .vale-ci.inion all 11 changed files: 0 errors, 0 warnings, 0 suggestionsidchanges, so no redirects neededNot 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.