fix(docs): Use platform-specific agent skills URL on JS common pages#18506
Open
philprime wants to merge 1 commit into
Open
fix(docs): Use platform-specific agent skills URL on JS common pages#18506philprime wants to merge 1 commit into
philprime wants to merge 1 commit into
Conversation
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.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
| --- | ||
|
|
||
| <AgentSkillsCallout /> | ||
| <PlatformContent includePath="llm-rules-platform" /> |
Contributor
There was a problem hiding this comment.
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.
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.
DESCRIBE YOUR PR
The shared JavaScript "common" pages for tracing and metrics used a bare
<AgentSkillsCallout />without askillprop, causing the Agent-Assisted Setup section to show the generichttps://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.mdxdocs/platforms/javascript/common/metrics/index.mdxIS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes: