Skip to content

docs(js): Use split layout in node quick start guides#17360

Open
inventarSarah wants to merge 1 commit intomasterfrom
smi/quick-start/split-layout-nodejs
Open

docs(js): Use split layout in node quick start guides#17360
inventarSarah wants to merge 1 commit intomasterfrom
smi/quick-start/split-layout-nodejs

Conversation

@inventarSarah
Copy link
Copy Markdown
Collaborator

@inventarSarah inventarSarah commented Apr 16, 2026

DESCRIBE YOUR PR

This branch updates the following quick start guides to use the new split layout:

  • Node.js
  • Connect
  • Express
  • Fastify
  • Hapi
  • Hono
  • Hono on Cloudflare
  • Koa

I grouped them all in this PR because they all use the same main content file (except Hono on Cloudflare), and only the "Verify" section uses a dedicated file for each.

For Hono, I also removed some duplicate content regarding the different runtimes from the quick start guide.

Closes: #17358

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: 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 added an urgent due date to it.
    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

EXTRA RESOURCES

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 16, 2026

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

Project Deployment Actions Updated (UTC)
sentry-docs Ready Ready Preview, Comment Apr 16, 2026 8:36am
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Apr 16, 2026 8:36am

Request Review

Copy link
Copy Markdown
Contributor

@coolguyzone coolguyzone left a comment

Choose a reason for hiding this comment

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

Markup looks good, verified that all these guides work as expected.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the JavaScript (Node and framework) quick start guides to use the new split layout (and step connector numbering), and simplifies some Hono runtime-related guide content.

Changes:

  • Wrap “Verify” sections for Node/Connect/Express/Fastify/Hapi/Hono/Koa in <SplitLayout> blocks and switch logs verify include to the split-layout variant.
  • Convert the Node and Hono-on-Cloudflare quick start structure to StepConnector + split layout sections, and move source maps to the split-layout include.
  • Remove duplicated runtime-specific content from the Hono guide and delete the now-unused Hono-specific sourcemaps short-version include.

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
platform-includes/getting-started-verify/javascript.node.mdx Wrap verify snippets in split layout; update tracing snippet formatting; use split-layout logs verify include.
platform-includes/getting-started-verify/javascript.koa.mdx Wrap verify snippets in split layout; use split-layout logs verify include.
platform-includes/getting-started-verify/javascript.hono.mdx Wrap verify snippets in split layout; use split-layout logs verify include.
platform-includes/getting-started-verify/javascript.hapi.mdx Wrap verify snippets in split layout; use split-layout logs verify include.
platform-includes/getting-started-verify/javascript.fastify.mdx Wrap verify snippets in split layout; use split-layout logs verify include.
platform-includes/getting-started-verify/javascript.express.mdx Wrap verify snippets in split layout; use split-layout logs verify include.
platform-includes/getting-started-verify/javascript.connect.mdx Wrap verify snippets in split layout; use split-layout logs verify include.
platform-includes/getting-started-sourcemaps-short-version/javascript.hono.mdx Remove the Hono-specific sourcemaps short-version content file.
platform-includes/getting-started-node/javascript.mdx Add StepConnector, convert sections to split layout, and switch sourcemaps content to split-layout include.
platform-includes/getting-started-config/javascript.cloudflare.hono.mdx Wrap Cloudflare Hono config instructions in split layout.
docs/platforms/javascript/guides/koa/index.mdx Update page description text (contains a typo to fix).
docs/platforms/javascript/guides/hono/index.mdx Simplify runtime setup messaging and remove duplicated runtime-specific examples.
docs/platforms/javascript/guides/cloudflare/frameworks/hono.mdx Add StepConnector, add split layout blocks, and switch sourcemaps include to split-layout content.

---
title: Koa
description: "This guide explains how to set up Sentry in your Koa application."
description: "Learn how to manually set up Sentry in your Kono app and capture your first errors."
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

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

Typo in the frontmatter description: it says "Kono" but the framework is "Koa".

Suggested change
description: "Learn how to manually set up Sentry in your Kono app and capture your first errors."
description: "Learn how to manually set up Sentry in your Koa app and capture your first errors."

Copilot uses AI. Check for mistakes.
includePath="getting-started-sourcemaps-short-version"
platform="javascript.hono"
includePath="getting-started-sourcemaps-short-version-splitlayout"
platform="javascript"
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

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

This sourcemaps section uses the generic getting-started-sourcemaps-short-version-splitlayout content (platform="javascript"), which doesn't include Cloudflare-specific setup (for example enabling upload_source_maps in wrangler.(jsonc|toml)). Consider adding/using a Cloudflare-specific split-layout variant (for example platform-includes/getting-started-sourcemaps-short-version-splitlayout/javascript.cloudflare.mdx) and referencing that platform here so the instructions match the Cloudflare Workers workflow.

Suggested change
platform="javascript"
platform="javascript.cloudflare"

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Node.js quick start guides split layout

3 participants