Skip to content

feat(md-exports): List the quick starts for other runtimes in the frontmatter - #20367

Draft
JPeer264 wants to merge 1 commit into
jp/poc-selector-2-all-frameworksfrom
jp/quick-start-runtime-frontmatter
Draft

JPeer264 wants to merge 1 commit into
jp/poc-selector-2-all-frameworksfrom
jp/quick-start-runtime-frontmatter

Conversation

@JPeer264

Copy link
Copy Markdown
Member

DESCRIBE YOUR PR

This adds runtime and runtimes to the frontmatter of the .md exports of quick starts, so agents can find the quick start for their runtime. A quick start sets runtime in its MDX frontmatter, and the export builds the runtimes list from the quick starts for the other runtimes:

---
title: "Quick Start (Cloudflare)"
description: "Learn how to set up Sentry in your Next.js application deployed on Cloudflare Workers and capture your first errors."
url: https://docs.sentry.io/platforms/javascript/guides/nextjs/cloudflare/
runtime: cloudflare
runtimes:
  - runtime: node
    url: https://docs.sentry.io/platforms/javascript/guides/nextjs.md
---
  • A guide page and its direct children with a runtime are one group, for example Next.js and Next.js on Cloudflare.
  • The Node.js, Bun, Deno and Cloudflare guides are one group.

Merge after #19974.

Frontmatter decisions

Pages set only runtime, and the export builds runtimes, so the lists cannot get out of date when a page moves. The alternative is a hand-written runtimes list in each page.

Known issues

  • The Hono quick start covers several runtimes in tabs, so it has no runtime, and Hono on Cloudflare lists no other runtimes.
  • The Hydrogen quick start has no 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

@vercel

vercel Bot commented Oct 31, 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 Oct 31, 2026 9:28pm UTC
sentry-docs Ready Ready Preview Oct 31, 2026 9:28pm UTC

Request Review

@github-actions github-actions Bot added the Priority: Normal Docs review has no urgent deadline label Oct 31, 2026
@JPeer264
JPeer264 added this pull request to stack #20366 October 31, 2026 20:37
…ntmatter

The Markdown export of a quick start with `runtime` frontmatter writes
`runtime` and a `runtimes` list with the .md URLs of the quick starts for
the other runtimes, so agents can find the right quick start for their
runtime.

A guide page and its direct children with a `runtime` are one group, for
example Next.js and Next.js on Cloudflare. Guide pages with a `runtime`
and no runtime children (Node.js, Bun, Deno, Cloudflare) are one group
per platform, so these guides set `runtime` too.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

This branch was successfully deployed

2 active deployments
Preview – sentry-docs — 3d9d9d60 Deployed Oct 31, 2026 by vercel[bot]
Preview – develop-docs — 3d9d9d60 Deployed Oct 31, 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.

1 participant