Skip to content

docs(js): use supportedCategories for crons, MCP, and queues/caches pages - #19505

Open
mydea wants to merge 1 commit into
guide-cat/13-node-integrationsfrom
guide-cat/14-crons-mcp-queues
Open

mydea wants to merge 1 commit into
guide-cat/13-node-integrationsfrom
guide-cat/14-crons-mcp-queues

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 #19504; review/merge bottom-up.

Replace the enumerated server-framework supported lists on crons/*, mcp-monitoring, and the queues/caches instrumentation pages with supportedCategories: [server].

  • These already listed all edge runtimes; the category form additionally covers guides stale-omitted from the manual lists.
  • MCP monitoring's wrapMcpServerWithSentry lives in @sentry/core and is runtime-agnostic, so [server] is accurate.

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 21, 2026 9:11am UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Sep 21, 2026 9:11am UTC

Request Review

@mydea
mydea added this pull request to stack #19507 September 18, 2026 10:24
@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 force-pushed the guide-cat/14-crons-mcp-queues branch from cb5a535 to fea6bff Compare September 18, 2026 10:50
@mydea
mydea marked this pull request as ready for review September 18, 2026 11:10
@codeowner-assignment
codeowner-assignment Bot requested a review from a team September 18, 2026 11:10
Comment on lines +6 to +7
supportedCategories:
- server

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 supportedCategories: [server] hides documentation from platforms like AWS Lambda because their configs lack a categories field, causing the isSupported check to fail.
Severity: HIGH

Suggested Fix

To fix this, add the categories: [server] property to the config.yml files for all relevant serverless platforms (e.g., aws-lambda, azure-functions, gcp-functions). Alternatively, revert the front matter filtering on the affected pages to use the previous explicit supported list, or modify the isSupported function to handle missing categories.

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/crons/troubleshooting.mdx#L6-L7

Potential issue: The change from an explicit `supported` list to `supportedCategories:
[server]` in the front matter of documentation pages introduces a bug. The `isSupported`
function in `frontmatter.ts` now checks if a platform's `categories` array includes
`'server'`. However, serverless platforms like `aws-lambda`, `azure-functions`, and
`gcp-functions` do not have a `categories` field defined in their `config.yml`. As a
result, the check fails, and these platforms are incorrectly excluded from seeing
relevant documentation pages, such as the crons documentation, despite being listed in
`<PlatformSection>` components on the page.

Also affects:

  • docs/platforms/javascript/common/crons/index.mdx:7~8

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

…ages

Replace the enumerated server-framework `supported` lists on crons/*,
mcp-monitoring, and the queues/caches instrumentation pages with
`supportedCategories: [server]`. These already listed all edge runtimes
(cloudflare/deno/bun); the category form additionally covers the guides that
were stale-omitted from the manual lists (effect, elysia, firebase, mastra,
nitro, and some meta-frameworks).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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