docs(js): Use split layout in node quick start guides#17360
docs(js): Use split layout in node quick start guides#17360inventarSarah wants to merge 1 commit intomasterfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
coolguyzone
left a comment
There was a problem hiding this comment.
Markup looks good, verified that all these guides work as expected.
There was a problem hiding this comment.
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." |
There was a problem hiding this comment.
Typo in the frontmatter description: it says "Kono" but the framework is "Koa".
| 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." |
| includePath="getting-started-sourcemaps-short-version" | ||
| platform="javascript.hono" | ||
| includePath="getting-started-sourcemaps-short-version-splitlayout" | ||
| platform="javascript" |
There was a problem hiding this comment.
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.
| platform="javascript" | |
| platform="javascript.cloudflare" |
DESCRIBE YOUR PR
This branch updates the following quick start guides to use the new split layout:
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.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
EXTRA RESOURCES