Skip to content

docs(js): scope browser Special Use Cases to browser-only platforms - #19511

Open
mydea wants to merge 2 commits into
guide-cat/15-async-contextfrom
guide-cat/16-special-use-cases
Open

mydea wants to merge 2 commits into
guide-cat/15-async-contextfrom
guide-cat/16-special-use-cases

Conversation

@mydea

@mydea mydea commented Sep 18, 2026

Copy link
Copy Markdown
Member

DESCRIBE YOUR PR

Stacked PR. Part of the JavaScript guide-categories series (#19492#19513). Depends on #19506; review/merge bottom-up.

The Special Use Cases overview and its browser-specific guides (Micro Frontends, Shared Environments / Browser Extensions, Offline Caching, Multiple Sentry Instances) are relevant only to browser SPAs. Replace their partial, stale backend notSupported lists with supportedCategories: [browser-only].

  • Excludes meta-frameworks (astro, nextjs, nuxt, remix, …) and all server runtimes — the previous lists did this inconsistently (excluded the 13 original Node backends but still rendered on bun/cloudflare/deno/elysia/firebase/mastra).
  • Offline Caching keeps its explicit notSupported (capacitor, cordova, electron, wasm).
  • sentry-testkit intentionally left unrestricted (a transport-override testing tool usable in browser or Node tests).

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

🤖 Generated with Claude Code

@vercel

vercel Bot commented Sep 18, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated
sentry-docs Ready Ready Preview Sep 23, 2026 7:59am UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Sep 23, 2026 7:59am UTC

Request Review

@mydea
mydea added this pull request to stack #19507 September 18, 2026 11:29
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Sep 18, 2026
@github-actions github-actions Bot added Priority: Normal Docs review has no urgent deadline and removed Priority: Needs Triage The PR description is missing valid priority information labels Sep 18, 2026
@mydea
mydea marked this pull request as ready for review September 21, 2026 07:12
@codeowner-assignment
codeowner-assignment Bot requested a review from a team September 21, 2026 07:12

@chargome chargome left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Is this one not also relevant for browser? e.g. oofline caching is also interesting for a nextjs app right?

@cursor cursor Bot left a comment

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.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 21183ab. Configure here.

- javascript.nitro
- javascript.nestjs
supportedCategories:
- browser-only

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.

Parent hide orphans child pages

Medium Severity

Scoping the Special Use Cases index to browser-only drops that sidebar folder on meta-frameworks and other non-browser-only platforms. Child pages that stay published—including Next.js deploying-on-cloudflare, plus unrestricted sentry-testkit and web-workers—lose their nav entry because a missing parent is omitted from the sidebar tree.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 21183ab. Configure here.

The Special Use Cases overview and its browser-specific guides (Micro
Frontends, Shared Environments / Browser Extensions, Offline Caching, Multiple
Sentry Instances) are relevant only to browser SPAs, not to meta-frameworks or
backends. Replace the partial (and stale) backend `notSupported` lists with
`supportedCategories: [browser-only]`.

- Excludes meta-frameworks (astro, nextjs, nuxt, remix, …) and all server
  runtimes, which the previous hand-maintained lists did inconsistently
  (they excluded the 13 original Node backends but still rendered on bun,
  cloudflare, deno, elysia, firebase, and mastra).
- Offline Caching additionally keeps its explicit `notSupported`
  (capacitor, cordova, electron, wasm).

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

mydea commented Sep 23, 2026

Copy link
Copy Markdown
Member Author

Is this one not also relevant for browser? e.g. oofline caching is also interesting for a nextjs app right?

right, I will make offline caching browser instead of browser-only!

Use the broader `browser` category instead of `browser-only` for the
Special Use Cases overview and Offline Caching, so meta-framework guides
(which have browser-relevant sub-pages) also render these pages. Offline
Caching keeps its explicit notSupported list (capacitor, cordova,
electron, wasm).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Comment on lines +6 to +7
supportedCategories:
- browser

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: Inconsistent supportedCategories between the parent index page (browser) and child pages (browser-only) will cause some documentation pages to be hidden for meta-framework users.
Severity: LOW

Suggested Fix

To ensure all child pages are visible for meta-framework guides, update the supportedCategories frontmatter in the affected child pages from [browser-only] to the broader [browser] category. This will align them with the parent index page and prevent them from being filtered out during the build process for platforms that don't define the browser-only category.

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/best-practices/index.mdx#L6-L7

Potential issue: There is an inconsistency in the `supportedCategories` frontmatter
property between a parent documentation page and its children. The parent index page for
'Special Use Cases' is assigned `supportedCategories: [browser]`, while several of its
child pages are assigned `supportedCategories: [browser-only]`. For meta-framework
platforms (e.g., Next.js) that do not include `browser-only` in their platform
categories, the build process will filter out these child pages. This results in a
degraded user experience where the index page is visible but appears incomplete, as it
will be missing links to the filtered-out child pages.

Also affects:

  • docs/platforms/javascript/common/best-practices/micro-frontends.mdx:5~6
  • docs/platforms/javascript/common/best-practices/shared-environments.mdx:5~6
  • docs/platforms/javascript/common/best-practices/multiple-sentry-instances.mdx:5~6

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

@coolguyzone coolguyzone left a comment

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.

LGTM, please resolve the issue brought up by the review bot.

This branch was successfully deployed

1 active deployment
Preview – sentry-docs d62f5d96 Deployed Sep 23, 2026 by vercel[bot]
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.

3 participants