Fix title-echoing meta descriptions and document the rules - #5160
Merged
Conversation
Adds a Meta descriptions subsection to AGENTS.md (length/placement, complement-the-title, no throat-clearing openers) and rewrites the 21 pages whose description restated the title instead of adding new information, drawing each replacement from the page's actual content. Remaining defects (throat-clearing openers, length-only stragglers) are tracked for a follow-up PR.
|
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.
Pull request overview
Updates meta-description guidance and rewrites 21 page descriptions to improve search-result snippets.
Changes:
- Documents meta-description length, wording, and content rules.
- Replaces title-echoing descriptions with page-specific summaries.
Reviewed changes
Copilot reviewed 22 out of 22 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
AGENTS.md |
Adds meta-description guidance. |
docs/web-ui.mdx |
Summarizes Web UI capabilities. |
docs/production-deployment/self-hosted-guide/visibility/elasticsearch.mdx |
Summarizes search-store setup. |
docs/production-deployment/self-hosted-guide/visibility/dual-visibility.mdx |
Summarizes Dual Visibility usage. |
docs/production-deployment/self-hosted-guide/visibility/custom-search-attributes.mdx |
Summarizes Search Attribute operations. |
docs/encyclopedia/workflow/cron-job.mdx |
Clarifies Cron Jobs and Schedules. |
docs/encyclopedia/temporal-service/temporal-service-configuration.mdx |
Summarizes configuration types. |
docs/encyclopedia/nexus/standalone-nexus-operation.mdx |
Describes standalone Nexus Operations. |
docs/develop/typescript/install-typescript-sdk.mdx |
Summarizes SDK installation options. |
docs/develop/task-queue-priority-fairness.mdx |
Describes Priority and Fairness. |
docs/design-patterns/event-accumulator.mdx |
Describes accumulation behavior. |
docs/design-patterns/batch-processing-patterns.mdx |
Identifies compared batch patterns. |
docs/cloud/monitor/index.mdx |
Summarizes monitoring coverage. |
docs/cloud/migrate/migrate-within-cloud.mdx |
Outlines regional migration. |
docs/cloud/manage-access/user-groups.mdx |
Summarizes group access management. |
docs/cloud/manage-access/service-accounts.mdx |
Describes service-account authentication. |
docs/cloud/manage-access/roles-and-permissions.mdx |
Summarizes Cloud RBAC. |
docs/cloud/index.mdx |
Summarizes Cloud guide contents. |
docs/cloud/get-started/index.mdx |
Outlines Cloud onboarding. |
docs/cloud/export.mdx |
Summarizes Workflow History Export. |
docs/cloud/connectivity/ip-addresses.mdx |
Contrasts dynamic and Stable IPs. |
docs/cloud/billing-and-usage/billing-api.mdx |
Summarizes billing reports. |
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Duncanma
marked this pull request as ready for review
August 21, 2026 20:19
flippedcoder
approved these changes
Aug 21, 2026
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.
Summary
descriptionrestated the title instead of adding new information — some were literal duplicates of the title string. Each replacement was drawn from the page's actual content, lands in the 120-155 character target range, and leads with a term specific to that page.Highlights
docs/cloud/connectivity/ip-addresses.mdxdocs/design-patterns/batch-processing-patterns.mdxdocs/design-patterns/event-accumulator.mdxdocs/cloud/index.mdxFull before/after list for all 21 pages is in the PR diff.
Remaining work (follow-up PR)
An audit of all 755 pages under
docs/against the new rules found two more categories, left for a separate PR so this one stays reviewable: