Skip to content

docs: De-duplicate platform SDK meta descriptions - #19123

Open
coolguyzone wants to merge 10 commits into
masterfrom
coolguyzone/chore/de-dupe-descriptions
Open

docs: De-duplicate platform SDK meta descriptions#19123
coolguyzone wants to merge 10 commits into
masterfrom
coolguyzone/chore/de-dupe-descriptions

Conversation

@coolguyzone

@coolguyzone coolguyzone commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

part of DEVEX-665 ( Cleanup Duplicate Meta-Descriptions )

This PR capture a bunch of the low-hanging fruit: Making many of our duplicate meta-descriptions platform-specific so that they are unique.

Removes duplicate meta descriptions across platform SDK docs. Many data-management, enriching-events, and configuration pages shared identical frontmatter description values across every platform, which weakens per-page SEO/LLM relevance signal. This makes them platform-specific by injecting the SDK name (e.g. "the Sentry Android SDK").

Covers 15 duplicate-description groups (~224 pages):

  • data-collected (21 pages) — "See what data is collected by the Sentry {Platform} SDK."
  • tags (21 pages) — "Tags in Sentry's {Platform} SDK power UI features…"
  • sensitive-data (20 pages) — "…filtering or scrubbing sensitive data within the Sentry {Platform} SDK…"
  • 12 SDK config/usage groups (162 pages) — options, releases, environments, identify-user, filtering, manual capture, fingerprinting, scopes, and manual setup descriptions that referenced "the SDK"/"your SDK"

Edge cases handled: guide pages use their framework name (Flutter, Remix, SvelteKit, Laravel, Symfony, Kotlin Multiplatform); the legacy Java config page and versioned (__v*) variants are disambiguated.

Scope note: 111 remaining duplicate groups whose descriptions don't reference the SDK (product-concept copy) were intentionally left as-is to avoid awkward or inaccurate phrasing.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.
Select exactly one option. For deadlines, replace YYYY-MM-DD with the due date. You can update this information later by editing the PR description.

  • Urgent deadline (GA date, etc.): YYYY-MM-DD
  • Other deadline: YYYY-MM-DD
  • No deadline: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've supplied a deadline.

Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

coolguyzone and others added 4 commits August 25, 2026 11:48
Replace the shared "See what data is collected by the Sentry SDK."
description on 21 data-management/data-collected pages with per-platform
copy (e.g. "...Sentry Apple SDK.") to remove duplicate meta descriptions.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Replace the shared "Tags power UI features..." description on 21
enriching-events/tags pages with per-platform copy (e.g. "Tags in
Sentry's Android SDK power UI features...") to remove duplicate meta
descriptions.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Replace the shared "Learn about filtering or scrubbing sensitive
data..." description on 20 data-management/sensitive-data pages with
per-platform copy (e.g. "...within the Sentry Android SDK...") to remove
duplicate meta descriptions.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
De-duplicate 12 more cross-platform meta-description groups by injecting
the platform name into descriptions that reference "the SDK"/"your SDK"
(options, releases, environments, identify-user, filtering, manual
capture, fingerprinting, scopes, setup). Covers 162 platform pages.

Guide pages use their framework name (e.g. Flutter, Remix, SvelteKit);
the legacy Java config page and versioned variants are disambiguated.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@vercel

vercel Bot commented Aug 25, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
sentry-docs Ready Ready Preview Aug 25, 2026 9:50pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Preview Aug 25, 2026 9:50pm

Request Review

@codeowner-assignment
codeowner-assignment Bot requested review from a team August 25, 2026 20:14
@github-actions github-actions Bot added the Priority: Normal Docs review has no urgent deadline label Aug 25, 2026
@coolguyzone
coolguyzone removed request for a team August 25, 2026 20:18
@linear-code

linear-code Bot commented Aug 25, 2026

Copy link
Copy Markdown

DEVEX-665

@coolguyzone
coolguyzone requested a review from sfanahata August 25, 2026 20:50
Replace the shared "Custom contexts allow you to attach arbitrary
data..." description on 18 enriching-events/context pages with
per-platform copy ("...to an event in the Sentry {Platform} SDK.") to
remove duplicate meta descriptions.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@codeowner-assignment
codeowner-assignment Bot requested review from a team August 25, 2026 21:05
@codeowner-assignment
codeowner-assignment Bot requested a review from a team August 25, 2026 21:05
coolguyzone and others added 2 commits August 25, 2026 14:11
Replace the shared "Learn what transactions are captured after tracing
is enabled." description on 18 tracing instrumentation pages with
per-platform/framework copy ("...enabled in the Sentry {Name} SDK.").
Guide pages use their framework name (ASP.NET Core, Spring Boot, Express,
Nest.js, etc.).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Replace the shared "Learn how to connect events across
applications/services." description on 16 tracing trace-propagation /
distributed-tracing pages with per-platform copy ("...using the Sentry
{Platform} SDK.").

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
coolguyzone and others added 3 commits August 25, 2026 14:26
Replace the shared "Learn how to capture performance data on any action
in your app." description on 15 tracing custom-instrumentation pages with
per-platform copy ("...using the Sentry {Platform} SDK.").

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…pecific

Replace the shared "Learn how to instrument tracing in your app."
description on 15 tracing/instrumentation index pages with per-platform
copy ("...using Sentry's {Platform} SDK.").

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Replace the shared "Learn more about the default behavior of our SDK if
the application shuts down unexpectedly." description on 13 configuration
draining pages with per-platform copy ("...of Sentry's {Platform} SDK
if..."). The two Python files are version-variants of the same URL.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Normal Docs review has no urgent deadline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant