fix(seo): fix all titles#183
Conversation
gregberge
requested review from
a team,
Copilot and
jsfez
and removed request for
a team
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
This PR refactors documentation metadata to improve SEO by separating sidebar labels from page titles. The changes allow the system to automatically derive page titles from H1 headings while using explicit sidebar_label values for navigation.
- Replaces
title:withsidebar_label:in front matter for most documentation files - Removes
title:field from files where the H1 heading serves as the page title - Adjusts H1 heading capitalization in several files for consistency
- Removes extraneous blank lines in some documents
Reviewed changes
Copilot reviewed 44 out of 44 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/sdks/nodejs.mdx | Changes front matter from title: to sidebar_label: |
| docs/sdks/cli.mdx | Changes front matter from title: to sidebar_label: |
| docs/quickstart/webdriverio.mdx | Changes front matter from title: to sidebar_label: |
| docs/quickstart/storybook/storybook-test-runner.mdx | Changes front matter from title: to sidebar_label: |
| docs/quickstart/storybook/storybook-legacy.mdx | Changes front matter from title: to sidebar_label: |
| docs/quickstart/storybook/index.mdx | Changes front matter from title: to sidebar_label: |
| docs/quickstart/react-router.mdx | Changes front matter from title: to sidebar_label: |
| docs/quickstart/puppeteer.mdx | Changes front matter from title: to sidebar_label: |
| docs/quickstart/playwright.mdx | Changes front matter from title: to sidebar_label: |
| docs/quickstart/next.mdx | Changes front matter from title: to sidebar_label: |
| docs/quickstart/e2e-tool.mdx | Changes front matter from title: to sidebar_label: |
| docs/quickstart/cypress.mdx | Changes front matter from title: to sidebar_label: |
| docs/learn/review-workflow/summary-checks.mdx | Removes title: field and updates H1 heading capitalization |
| docs/learn/review-workflow/pull-request-comments.mdx | Removes title: field from front matter |
| docs/learn/reliability/flaky-tests/dates.mdx | Changes front matter from title: to sidebar_label: |
| docs/learn/reliability/flaky-test-detection.mdx | Removes title: field and adds H1 heading |
| docs/learn/integrations/slack.mdx | Changes front matter from title: to sidebar_label: |
| docs/learn/integrations/index.mdx | Removes title: field from front matter |
| docs/learn/integrations/gitlab.mdx | Changes front matter from title: to sidebar_label: |
| docs/learn/integrations/github.mdx | Changes front matter from title: to sidebar_label: |
| docs/learn/integrations/bitbucket.mdx | Changes front matter from title: to sidebar_label: |
| docs/learn/integrations/azure-devops.mdx | Changes front matter from title: to sidebar_label: |
| docs/learn/guides/visual-coverage/viewports.mdx | Removes title: field and updates H1 heading |
| docs/learn/guides/visual-coverage/storybook-story-modes.mdx | Changes front matter from title: to sidebar_label: |
| docs/learn/guides/visual-coverage/screenshot-pages-script.mdx | Changes front matter from title: to sidebar_label: |
| docs/learn/guides/visual-coverage/screenshot-metadata.mdx | Removes title: field and updates H1 heading |
| docs/learn/guides/ci-pipelines/skip-build.mdx | Removes title: field and updates H1 heading |
| docs/learn/guides/ci-pipelines/run-on-preview-deployment.mdx | Changes title: to sidebar_label: and updates H1 heading |
| docs/learn/guides/ci-pipelines/parallel-testing.mdx | Changes title: to sidebar_label: and updates H1 heading |
| docs/learn/guides/ci-pipelines/build-splitting.mdx | Changes title: to sidebar_label: and updates H1 heading |
| docs/learn/fundamentals/monitoring-mode.mdx | Removes title: field from front matter |
| docs/learn/fundamentals/diff-algorithm.mdx | Changes front matter from title: to sidebar_label: |
| docs/learn/fundamentals/baseline-build.mdx | Removes title: field and updates H1 heading |
| docs/learn/billing/subscription/usage-monitoring.mdx | Removes title: field from front matter |
| docs/learn/billing/subscription/pricing-plans.mdx | Removes title: field from front matter |
| docs/learn/billing/subscription/open-source.mdx | Removes title: field and updates H1 heading |
| docs/learn/billing/subscription/manage-subscription.mdx | Removes title: field from front matter |
| docs/learn/billing/subscription/invoiced-customers.mdx | Removes title: field from front matter |
| docs/learn/billing/subscription/how-to-subscribe.mdx | Removes title: field from front matter |
| docs/learn/billing/spend-management.mdx | Removes title: field from front matter |
| docs/learn/account-and-access/team-members-and-roles.mdx | Removes title: field from front matter |
| docs/learn/account-and-access/github-sso.mdx | Changes front matter from title: to sidebar_label: |
| docs/learn/account-and-access/account-management.mdx | Removes title: field from front matter |
| docs/introduction.mdx | Removes title: field from front matter |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| --- | ||
|
|
||
| # Adding Screenshot Metadata | ||
| # Adding Screenshot metadata |
There was a problem hiding this comment.
The heading should be "Adding screenshot metadata" to be consistent with the capitalization style used in other headings. The lowercase "m" in "metadata" is inconsistent with the title case pattern used elsewhere in the documentation (e.g., "Skipping a build", "Baseline build", "Monorepos setup").
| # Adding Screenshot metadata | |
| # Adding screenshot metadata |
| --- | ||
|
|
||
| # Configuring Responsive Viewports | ||
| # Responsive viewports |
There was a problem hiding this comment.
The capitalization style is inconsistent. The heading uses lowercase "viewports" while the sidebar_label was "Responsive Viewports" (title case). Consider using "Responsive Viewports" to maintain consistency with the previous title and other documentation headings.
| # Responsive viewports | |
| # Responsive Viewports |
| --- | ||
|
|
||
| # Skipping a Build | ||
| # Skipping a build |
There was a problem hiding this comment.
The capitalization style is inconsistent across similar headings. Consider using title case "Skipping a Build" to match other similar headings like "Baseline Build" and "Account Management".
| --- | ||
|
|
||
| # Run on Preview Deployments | ||
| # Run on preview deployments |
There was a problem hiding this comment.
The capitalization is inconsistent. Consider using title case "Run on Preview Deployments" to match the sidebar_label and maintain consistency with other headings like "Baseline Build" and "Account Management".
| --- | ||
|
|
||
| # Parallel Testing (Sharding) | ||
| # Parallel testing (sharding) |
There was a problem hiding this comment.
The capitalization is inconsistent. Consider using title case "Parallel Testing (Sharding)" to match other headings in the documentation like "Baseline Build" and "Account Management".
| --- | ||
|
|
||
| # Open Source | ||
| # Open source |
There was a problem hiding this comment.
The capitalization is inconsistent. Consider using title case "Open Source" to match the heading style used in other documents like "Team Members & Roles" and "Account Management".
| # Open source | |
| # Open Source |
| --- | ||
|
|
||
| # Summary Checks | ||
| # Summary checks |
There was a problem hiding this comment.
The capitalization in the heading should be consistent with similar headings. Consider using "Summary Checks" (title case) to match the pattern used in other documentation sections, rather than lowercase "checks". This is inconsistent with how other similar headings are capitalized (e.g., "Team Members & Roles", "Account Management").
| import { RunPkgCommand } from "@site/src/partials"; | ||
|
|
||
| # Monorepos Setup | ||
| # Monorepos setup |
There was a problem hiding this comment.
The capitalization is inconsistent. Consider using title case "Monorepos Setup" to match other headings in the documentation and maintain consistency.
| # Monorepos setup | |
| # Monorepos Setup |
| import projectBranchesSettings from "./baseline-build/project-branches-settings.png"; | ||
|
|
||
| # Baseline Build | ||
| # Baseline build |
There was a problem hiding this comment.
The capitalization is inconsistent. Consider using title case "Baseline Build" to match other similar headings like "Team Members & Roles" and "Account Management".
| # Baseline build | |
| # Baseline Build |
No description provided.