Skip to content

feat(nitro): Nitro SDK Docs#17468

Merged
logaretm merged 12 commits intomasterfrom
awad/nitro-sdk
May 5, 2026
Merged

feat(nitro): Nitro SDK Docs#17468
logaretm merged 12 commits intomasterfrom
awad/nitro-sdk

Conversation

@logaretm
Copy link
Copy Markdown
Member

@logaretm logaretm commented Apr 23, 2026

Adds the Nitro SDK docs, it was released in 10.51.0

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+

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 23, 2026

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

Project Deployment Actions Updated (UTC)
sentry-docs Ready Ready Preview, Comment May 5, 2026 5:44pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Preview May 5, 2026 5:44pm

Request Review

@logaretm logaretm changed the title feat(nitro): SDK Docs feat(nitro): Nitro SDK Docs Apr 28, 2026
@logaretm logaretm requested review from a team, inventarSarah and s1gr1d and removed request for s1gr1d April 30, 2026 18:47
@logaretm logaretm marked this pull request as ready for review April 30, 2026 18:47
Copilot AI review requested due to automatic review settings April 30, 2026 18:47
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

Adds initial documentation and UI support for the new Nitro JavaScript SDK within the docs site, including platform icon support and platform-specific source maps guidance.

Changes:

  • Add Nitro platform icon mappings (nitro + javascript-nitro) to the platform icon component.
  • Add a new Nitro guide page (/platforms/javascript/guides/nitro/) and Nitro-specific source maps include content.
  • Bump platformicons dependency to a version which includes the Nitro icon assets.

Reviewed changes

Copilot reviewed 5 out of 6 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
src/components/platformIcon.tsx Adds Nitro SVG imports and maps javascript-nitro to the Nitro icon.
package.json Updates platformicons to ^9.4.0 to pick up Nitro icon assets.
pnpm-lock.yaml Lockfile updates reflecting the dependency bump (plus additional transitive changes).
platform-includes/sourcemaps/primer/javascript.nitro.mdx Adds Nitro-specific source maps “primer” include content.
platform-includes/sourcemaps/overview/javascript.nitro.mdx Adds Nitro-specific source maps “overview” include content (includes troubleshooting link).
docs/platforms/javascript/guides/nitro/index.mdx Adds the main Nitro SDK setup/feature guide page.
Files not reviewed (1)
  • pnpm-lock.yaml: Language not supported

Comment thread platform-includes/sourcemaps/overview/javascript.nitro.mdx
Comment thread docs/platforms/javascript/guides/nitro/index.mdx
Comment thread docs/platforms/javascript/guides/nitro/index.mdx
Comment thread pnpm-lock.yaml
Copy link
Copy Markdown
Collaborator

@inventarSarah inventarSarah left a comment

Choose a reason for hiding this comment

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

Thanks, looks good overall!

I left a couple of suggestions for you to review.

Two more points:

  1. If it's not on your to-do list already anyway, please also have another look at the navigation and remove the pages we don't need for Nitro (for example, Session Replay).
  2. If you have the time, you could update the guide to use the new split layout. You can see how that works in almost any JavaScript quick start guide (example). Otherwise, I will update it once I revisit the page to clean up the "Features" section 👍

Comment thread docs/platforms/javascript/guides/nitro/index.mdx
Comment thread docs/platforms/javascript/guides/nitro/index.mdx
Comment thread docs/platforms/javascript/guides/nitro/index.mdx
`@sentry/nitro` automatically generates and uploads source maps when you build your Nitro application for production, so that errors in Sentry contain readable stack traces.

To configure source map uploads, provide your Sentry auth token, organization, and project slugs to the `withSentryConfig` wrapper:

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I believe the code block is missing?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

So it's referring to the second code snippet in the tabbed code below, but I think this would be confusing.

I split the code snippets into two snippets, and move paragraphs around so it is less confusing.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thank you, now it's clearer 👍

Comment thread platform-includes/sourcemaps/overview/javascript.nitro.mdx
Comment thread platform-includes/sourcemaps/primer/javascript.nitro.mdx
@codeowner-assignment codeowner-assignment Bot requested a review from a team May 4, 2026 14:44
@logaretm
Copy link
Copy Markdown
Member Author

logaretm commented May 4, 2026

@inventarSarah Noticed there was a lot of sidebar/page supported/notSupported settings that needed references to the nitro SDK, this exploded the changes a bit but hono and some other Server SDKs seems to do that as well.

Is that the best way to do that?

I also addressed the rest of your comments, thanks for the review!

@logaretm logaretm removed the request for review from a team May 4, 2026 15:08
@codeowner-assignment codeowner-assignment Bot requested a review from a team May 4, 2026 15:09
Copy link
Copy Markdown
Collaborator

@inventarSarah inventarSarah left a comment

Choose a reason for hiding this comment

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

Thanks for the updates! The changes look good to me (only left 1 comment) -- and no worries about pr size for these changes.

I noticed most of the other SDKs have main nav items "AI Agent Monitoring" and "Crons" which Nitro currently does not -- just double-checking if this looks correct to you.

</SplitSectionCode>
</SplitSection>
</SplitLayout>

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

The Source Maps section is now missing.
You can add it as the last section under "2 Configuration" using an h3 for the title

`@sentry/nitro` automatically generates and uploads source maps when you build your Nitro application for production, so that errors in Sentry contain readable stack traces.

To configure source map uploads, provide your Sentry auth token, organization, and project slugs to the `withSentryConfig` wrapper:

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thank you, now it's clearer 👍

Comment thread platform-includes/sourcemaps/overview/javascript.nitro.mdx
@logaretm logaretm merged commit 561b012 into master May 5, 2026
19 of 20 checks passed
@logaretm logaretm deleted the awad/nitro-sdk branch May 5, 2026 17:57
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.

4 participants