docs: add per-page og:title for richer social share cards#164
Merged
Conversation
Social share cards (Slack/LinkedIn/Twitter unfurls) showed "<Page> - Trunk Platform Documentation", which doesn't say which Trunk product the page belongs to. Add a per-page og:title that names the product in natural language (e.g. "Using Bazel with Trunk Flaky Tests"). og:title overrides only the share card; the on-page H1, sidebar label, and browser tab (all driven by `title`) are unchanged. twitter:title inherits from og:title automatically. Scope: active pillars only (flaky-tests, merge-queue, setup-and-administration, home). Skips deprecated code-quality/ ci-autopilot, the frozen changelog, and links/ redirect stubs. Also backfills descriptions on 8 pages that had none. 142 pages, +150 lines (142 og:title, 8 description). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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
1 participant
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.
What
Adds a per-page
og:titleto every active-pillar doc so social share cards (Slack, LinkedIn, Twitter unfurls) name the Trunk product instead of the generic site suffix.Before:
Bazel - Trunk Platform DocumentationAfter:
Using Bazel with Trunk Flaky TestsWhy it's safe
og:titleoverrides only the share card. The on-page H1, the sidebar label, and the browser tab are all driven bytitleand are untouched.twitter:titleinherits fromog:title, so one field covers every platform. (Mintlify page-specific meta tags)Scope
Active pillars only: flaky-tests (94), merge-queue (38), setup-and-administration (9), home (1) = 142 pages.
Deliberately skipped:
code-quality/andci-autopilot/(deprecated; ci-autopilot is also wholesale-redirected to home)changelog/(frozen historical snapshots)links/*redirect stubs (they inherit their target's card)Also backfilled
descriptionon 8 pages that had none, so the card's second line isn't empty.Format
Natural-language phrasing, every title contains "Trunk", kept under ~60 chars to avoid truncation. Rulebook + the full generator live in
.claude/tmp/seo-share-metadata/(not committed). Patterns:Using {X} with Trunk Flaky TestsThe {Monitor} in Trunk Flaky Tests{Feature} in Trunk Merge QueueTrunk {Product} {API|CLI} referenceDiff
142 files, +150 lines (142
og:title, 8description). Pure frontmatter additions, no body changes. Frontmatter YAML validated on all 142 files.Full share-card title list (142 pages) for bulk review
Trunk Flaky Tests (94)
agents/autofix-ci-failures.mdxagents/autofix-flaky-tests.mdxagents/index.mdxchangelog.mdxdashboard.mdxdetection/failure-count-monitor.mdxdetection/failure-rate-monitor.mdxdetection/flag-as-flaky.mdxdetection/index.mdxdetection/infrastructure-failure-protection.mdxdetection/new-test-monitor.mdxdetection/pass-on-retry-monitor.mdxdetection/skipped-test-monitor.mdxdetection/slow-test-monitor.mdxdetection/the-importance-of-pr-test-results.mdxget-started/ci-providers/atlassian-bamboo.mdxget-started/ci-providers/azure-devops-pipelines.mdxget-started/ci-providers/bitbucket-pipelines.mdxget-started/ci-providers/buildkite.mdxget-started/ci-providers/circleci.mdxget-started/ci-providers/droneci.mdxget-started/ci-providers/github-actions.mdxget-started/ci-providers/gitlab.mdxget-started/ci-providers/google-cloud-build.mdxget-started/ci-providers/index.mdxget-started/ci-providers/jenkins.mdxget-started/ci-providers/otherci.mdxget-started/ci-providers/semaphoreci.mdxget-started/ci-providers/travisci.mdxget-started/frameworks/android.mdxget-started/frameworks/bazel.mdxget-started/frameworks/behave.mdxget-started/frameworks/cypress.mdxget-started/frameworks/dart-test.mdxget-started/frameworks/googletest.mdxget-started/frameworks/gotestsum.mdxget-started/frameworks/gradle.mdxget-started/frameworks/index.mdxget-started/frameworks/jasmine.mdxget-started/frameworks/jest.mdxget-started/frameworks/karma.mdxget-started/frameworks/kotest.mdxget-started/frameworks/maven.mdxget-started/frameworks/minitest.mdxget-started/frameworks/mocha.mdxget-started/frameworks/nightwatch.mdxget-started/frameworks/nunit.mdxget-started/frameworks/other-test-frameworks.mdxget-started/frameworks/pest.mdxget-started/frameworks/phpunit.mdxget-started/frameworks/playwright.mdxget-started/frameworks/pytest.mdxget-started/frameworks/robot-framework.mdxget-started/frameworks/rspec/index.mdxget-started/frameworks/rspec/manual-uploads.mdxget-started/frameworks/rust.mdxget-started/frameworks/swift-testing.mdxget-started/frameworks/testplan.mdxget-started/frameworks/vitest.mdxget-started/frameworks/xctest.mdxget-started/index.mdxget-started/multiple-repositories.mdxmanagement/github-pull-request-comments.mdxmanagement/index.mdxmanagement/managing-detected-flaky-tests.mdxmanagement/test-labels.mdxmanagement/ticketing/index.mdxmanagement/ticketing/jira-integration.mdxmanagement/ticketing/linear-integration.mdxmanagement/ticketing/other-ticketing-platforms.mdxoverview.mdxquarantining/index.mdxquarantining/quarantine-service-availability.mdxreference/api-reference.mdxreference/cli-reference.mdxreference/index.mdxreference/mcp-reference/configuration/bearer-auth.mdxreference/mcp-reference/configuration/claude-code-cli.mdxreference/mcp-reference/configuration/claude-code-plugin.mdxreference/mcp-reference/configuration/cursor-ide.mdxreference/mcp-reference/configuration/gemini-cli.mdxreference/mcp-reference/configuration/github-copilot-ide.mdxreference/mcp-reference/configuration/index.mdxreference/mcp-reference/fix-flaky-test.mdxreference/mcp-reference/index.mdxreference/mcp-reference/investigate-ci-failure.mdxreference/mcp-reference/search-test.mdxreference/mcp-reference/set-up-test-uploads.mdxwebhooks/github-issues-integration.mdxwebhooks/index.mdxwebhooks/jira-integration.mdxwebhooks/linear-integration.mdxwebhooks/microsoft-teams-integration.mdxwebhooks/slack-integration.mdxTrunk Merge Queue (38)
administration/advanced-settings.mdxadministration/index.mdxadministration/metrics.mdxadministration/terraform.mdxchangelog.mdxchrome-extension.mdxgetting-started/configure-branch-protection.mdxgetting-started/configure-ci-status-checks.mdxgetting-started/index.mdxgetting-started/install-and-create-your-queue.mdxgetting-started/test-your-setup.mdxintegration-for-slack.mdxmerge-queue.mdxmigrating-from-github-merge-queue.mdxoptimizations/anti-flake-protection.mdxoptimizations/batching.mdxoptimizations/direct-merge-to-main.mdxoptimizations/index.mdxoptimizations/optimistic-merging.mdxoptimizations/parallel-queues/api.mdxoptimizations/parallel-queues/bazel.mdxoptimizations/parallel-queues/index.mdxoptimizations/parallel-queues/nx.mdxoptimizations/pending-failure-depth.mdxoptimizations/predictive-testing.mdxoptimizations/priority-merging.mdxreference/common-problems.mdxreference/index.mdxreference/merge-queue-cli-reference.mdxreference/merge.mdxreference/troubleshooting.mdxusing-the-queue/emergency-pull-requests.mdxusing-the-queue/force-merge.mdxusing-the-queue/handle-failed-pull-requests.mdxusing-the-queue/index.mdxusing-the-queue/monitor-queue-status.mdxusing-the-queue/reference.mdxwebhooks.mdxSetup & Administration (9)
apis/index.mdxapis/webhooks.mdxbilling.mdxconnecting-to-trunk.mdxgithub-app-permissions.mdxmanaging-your-organization.mdxsecurity.mdxsupport.mdxtrunk-sudo-app.mdxHome (1)
|
index.mdx| Trunk Platform Documentation |🤖 Generated with Claude Code