Skip to content

feat(js): support category-based page filtering in frontmatter - #19497

Merged
mydea merged 1 commit into
guide-cat/05-platform-hintsfrom
guide-cat/06-frontmatter-categories
Sep 21, 2026
Merged

mydea merged 1 commit into
guide-cat/05-platform-hintsfrom
guide-cat/06-frontmatter-categories

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 #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
  • 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:15am UTC
sentry-docs Ready Ready Preview Sep 21, 2026 8:15am 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

@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 2 potential issues.

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 5cbbf00. Configure here.

Comment thread src/frontmatter.ts
Comment thread src/frontmatter.ts
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 (in addition to any `supported` guide keys).
- A page with `notSupportedCategories` is hidden for matching platforms/guides
  (in addition to any `notSupported` guide keys).

This lets pages target e.g. all server SDKs with `notSupportedCategories:
[browser]` instead of enumerating every framework, and auto-covers new guides.

Both `isSupported` implementations (the doc-tree collector in frontmatter.ts
and the search collector in mdx.ts) resolve the current platform/guide's
categories and apply the new lists. Behavior is unchanged for pages that don't
use the new fields. Covered by commonContentInheritance.spec.ts against both
collectors.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@mydea
mydea force-pushed the guide-cat/06-frontmatter-categories branch from 48616a5 to ed8c1ce Compare September 21, 2026 08:06
@mydea
mydea merged commit d883369 into master Sep 21, 2026
25 checks passed
@mydea
mydea deleted the guide-cat/06-frontmatter-categories 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 #19497; review/merge bottom-up.

Replace the enumerated backend-framework `notSupported` lists on the
Session Replay pages with `notSupportedCategories: [server-only]`,
keeping non-category exclusions (`cordova`, `wasm`) explicit.

- Session Replay is browser-only; the category form auto-covers every
server-only SDK and picks up guides that were stale-omitted from the
manual lists (effect, firebase, mastra).

## 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 — ed8c1ce4 Deployed Sep 21, 2026 by vercel[bot]
Preview – develop-docs — ed8c1ce4 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