Skip to content

refactor(js): use browser-only/server-only directly in getPlatformHints - #19496

Merged
mydea merged 1 commit into
guide-cat/04-category-predicatesfrom
guide-cat/05-platform-hints
Sep 21, 2026
Merged

mydea merged 1 commit into
guide-cat/04-category-predicatesfrom
guide-cat/05-platform-hints

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 → #19506). Depends on #19495; review/merge bottom-up.

Key the “Only available on: Client/Server” hint in getPlatformHints off the new isBrowserOnly / isServerOnly category checks instead of hand-rolled runtime detection.

  • The hint is only informative on dual-runtime (meta-framework) platforms; on a single-runtime platform the option's runtime is already implied, so it's suppressed there.
  • Note: this also surfaces the hint on desktop (electron), which runs both a browser and a Node runtime.

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
develop-docs Ready Ready Preview Sep 21, 2026 8:09am UTC
sentry-docs Building Building Preview Sep 21, 2026 8:09am UTC

Request Review

@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Sep 18, 2026
@mydea
mydea added this pull request to stack #19507 September 18, 2026 10:24
@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 18, 2026 10:48
@mydea
mydea force-pushed the guide-cat/05-platform-hints branch from 9ac0caa to a35dfe3 Compare September 18, 2026 10:49
Replace the current-platform runtime check in getPlatformHints with direct
`isBrowserOnly` / `isServerOnly` category checks. The "Only available on:
Client/Server" hint is only informative on dual-runtime (meta-framework)
platforms; on a single-runtime platform the option's runtime is already
implied, so we suppress it there.

Note: this also surfaces the hint on `desktop` platforms (electron), which
carry neither `browser-only` nor `server-only` — electron runs both a browser
(renderer) and a Node (main) runtime, so the runtime note is appropriate
there. Previously it was suppressed on electron because it lacked an explicit
`browser`/`server` tag.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@mydea
mydea force-pushed the guide-cat/05-platform-hints branch from a35dfe3 to 2c22ada Compare September 21, 2026 08:06
@mydea
mydea merged commit febae0d into master Sep 21, 2026
23 checks passed
@mydea
mydea deleted the guide-cat/05-platform-hints branch September 21, 2026 08:30
mydea added a commit that referenced this pull request Sep 21, 2026
## DESCRIBE YOUR PR

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

Add `supportedCategories` / `notSupportedCategories` frontmatter fields
that gate common-content inheritance by platform category, alongside the
existing guide-name `supported` / `notSupported` lists.

- A page with `supportedCategories` is shown only for platforms/guides
whose categories match; `notSupportedCategories` hides matching ones.
- Lets pages target e.g. all server SDKs with `notSupportedCategories:
[browser]` instead of enumerating every framework, and auto-covers new
guides.
- Both `isSupported` implementations (doc-tree collector and search
collector) resolve categories and apply the new lists. Covered by
`commonContentInheritance.spec.ts`.
- This is the feature the remaining PRs in the stack build on.

## 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
- [x] 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](https://github.com/orgs/getsentry/teams/docs)

---

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

This branch was successfully deployed

2 active deployments
Preview – sentry-docs — 2c22ada7 Deployed Sep 21, 2026 by vercel[bot]
Preview – develop-docs — 2c22ada7 Deployed Sep 21, 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.

2 participants