Skip to content

fix(docs): Use platform-specific agent skills URL on JS common pages#18506

Open
philprime wants to merge 1 commit into
masterfrom
philprime/fix-agent-assisted-setup-react-tracing
Open

fix(docs): Use platform-specific agent skills URL on JS common pages#18506
philprime wants to merge 1 commit into
masterfrom
philprime/fix-agent-assisted-setup-react-tracing

Conversation

@philprime

@philprime philprime commented Jun 23, 2026

Copy link
Copy Markdown
Member

DESCRIBE YOUR PR

The shared JavaScript "common" pages for tracing and metrics used a bare <AgentSkillsCallout /> without a skill prop, causing the Agent-Assisted Setup section to show the generic https://skills.sentry.dev/ URL on all JS guides (React, Next.js, Svelte, etc.).

Replaced with <PlatformContent includePath="llm-rules-platform" /> so each guide renders its own SDK-specific skills URL (e.g. sentry-react-sdk, sentry-nextjs-sdk), matching the pattern already used on guide index pages.

  • docs/platforms/javascript/common/tracing/index.mdx
  • docs/platforms/javascript/common/metrics/index.mdx

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: 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 added an urgent due date to it.
    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

Replace bare <AgentSkillsCallout /> with <PlatformContent includePath="llm-rules-platform" />
in the shared JS tracing and metrics pages so each guide (React, Next.js,
Svelte, etc.) renders its own SDK-specific skills URL instead of the
generic https://skills.sentry.dev/ fallback.
@vercel

vercel Bot commented Jun 23, 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, Comment Jun 23, 2026 9:06am
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Jun 23, 2026 9:06am

Request Review

@philprime philprime self-assigned this Jun 23, 2026
---

<AgentSkillsCallout />
<PlatformContent includePath="llm-rules-platform" />

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: Using <PlatformContent> on common JavaScript pages causes an incorrect fallback to "Browser JavaScript" content for many non-browser frameworks, creating inaccurate and inconsistent documentation.
Severity: LOW

Suggested Fix

Add the missing llm-rules-platform include files for the 30+ JavaScript guides that currently lack them. Alternatively, modify the implementation to ensure the fallback behavior does not misrepresent the SDK type for different frameworks.

Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.

Location: docs/platforms/javascript/common/metrics/index.mdx#L13

Potential issue: The pull request replaces a generic component with `<PlatformContent
includePath="llm-rules-platform" />` on shared JavaScript documentation pages for
metrics and tracing. For over 30 JavaScript frameworks (like Astro, SvelteKit, Nuxt,
Cloudflare) that lack a specific `llm-rules-platform` include file, the component
incorrectly falls back to displaying content for "Browser JavaScript" and the
`sentry-browser-sdk`. This is inaccurate because many of these are full-stack or
server-side frameworks. It also creates an inconsistency, as the main guide pages for
these frameworks often specify the correct, framework-specific SDK, while the shared
pages will now show the wrong information.

Also affects:

  • docs/platforms/javascript/common/tracing/index.mdx:9~9

Did we get this right? 👍 / 👎 to inform future reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant