Skip to content

Conversation

@sergical
Copy link
Member

@sergical sergical commented Dec 9, 2025

DESCRIBE YOUR PR

  • Updates quickstart to add a checklist to verify setup
  • Manual setup becomes more action driven with each step in the configuration / feature onboarding having it's own verification step

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

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

@linear
Copy link

linear bot commented Dec 9, 2025

@vercel
Copy link

vercel bot commented Dec 9, 2025

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

Project Deployment Review Updated (UTC)
develop-docs Ready Ready Preview, Comment Dec 12, 2025 10:31pm
sentry-docs Ready Ready Preview, Comment Dec 12, 2025 10:31pm

@codecov
Copy link

codecov bot commented Dec 10, 2025

Bundle Report

Changes will increase total bundle size by 108.94kB (0.31%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 24.83MB 108.94kB (0.44%) ⬆️
sentry-docs-client-array-push 10.23MB -6 bytes (-0.0%) ⬇️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
static/chunks/pages/_app-*.js -3 bytes 893.1kB -0.0%
static/chunks/9366-*.js -3 bytes 437.05kB -0.0%
static/1Kt3svxY33Um5Qlrb_gLi/_buildManifest.js (New) 684 bytes 684 bytes 100.0% 🚀
static/1Kt3svxY33Um5Qlrb_gLi/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/AAlnv7xX4i2IPXZ7gIk8U/_buildManifest.js (Deleted) -684 bytes 0 bytes -100.0% 🗑️
static/AAlnv7xX4i2IPXZ7gIk8U/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️
view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 5.46MB -0.0%
6529.js -3 bytes 4.88MB -0.0%
../instrumentation.js -3 bytes 4.78MB -0.0%
../app/[[...path]]/page.js.nft.json 36.32kB 1.11MB 3.38%
../app/platform-redirect/page.js.nft.json 36.32kB 1.11MB 3.38%
../app/sitemap.xml/route.js.nft.json 36.32kB 1.11MB 3.39%

sergical and others added 4 commits December 10, 2025 20:48
…ide-nextjs' of github.com:getsentry/sentry-docs into sergiydybskiy/devex-149-net-new-full-getting-started-guide-nextjs
@sergical sergical changed the title feat(nextjs) Add Getting Started guide feat(nextjs) Update quickstart and manual setup Dec 11, 2025
@inventarSarah
Copy link
Collaborator

Hi @sergical!
First, thank you for working on this update. Nextjs is one of our more complex JS quick start guides -- i really appreciate the effort and thought you put into this. Below is my feedback, grouped by page so it's easier to follow.

Wizard

  • I agree that we don't need to show configuration steps here since the wizard already handles that. I believe the config section ended up in this guide for testing purposes (could be wrong, though). We don't have them in our other guides.
  • I like that the writing is tighter and in line with how we wanted the quick starts to be: focused with optional extra info via the Expandable components.
    • nit on the "What does the installation wizard do?" section: Your new version reads very cleanly, but we should make sure we provide valuable info and don't lose the context behind the changes. Users usually see which files changed via git, but they don't necessarily know what those changes mean
  • I really like the idea of adding a bit of gamification to the verification step. This part (in the wizard) has always been tricky to handle because everything gets auto-set up and then users need to manually verify features. I get your intentions here :)
    My thoughts:
    • how does this work when users use the "copy page" button?
    • the links to Sentry (logs, traces, etc) are hidden by default
    • I love ticking off tasks but feel like the tasks here are very basic -- would devs actually come back here to tick boxes? (all in all there's a lot of clicking with not much outcome)
    • having users reselect features may add friction (this was added with the config earlier, not your change)
    • could be good to consider adding support options here? -- if a user can't check off an item because something didn't work, they're stuck with no troubleshooting path right there
  • The sandbox warning is essential and should stay
  • Turbopack info may also still be needed. Could you double-check with the devs if you haven't already?

Manual Setup

Like i wrote earlier, great job taking on this beast of a guide :D

A few notes:

  • In general, the wizard and manual setup should lead to the same end result. Users shouldn't get "benefits" depending on which path they choose. I can't confirm this for your changes here, but just flagging it as context
  • The current version of the guide was built together with the devs, and they have insight into why certain info is there; a lot of the content is very intentional. Checking with them early, especially when I was restructuring or removing things, was really helpful for me and saved me from cutting content that turned out to be more important than I expected. Just wanted to share that
  • I like the idea of pairing config steps with their verification steps. It makes the flow feel much more actionable. I think we could improve this further
  • Tunneling: do we need to add the "Using Next.js Middleware on Turbopack" expandable? Worth checking with the devs
  • the manual setup page gets really long when all features are enabled. So adding a short intro explaining the structure (First we install and set up the basics; then we configure and verify each feature, ...) could help users orient themselves and prepare for what awaits them
  • re the structure across the main page vs. Pages Router vs. Webpack:
    • The main manual guide tells users to check the other setup pages if they use Pages Router or Webpack. But those pages tell them to start with the main setup -> users may not know which steps apply to them and which don't. This could be confusing and makes it easy to misconfigure or double-configure.
    • After reviewing Pages Router more closely, I'm not sure it has enough unique content to justify a completely separate page. It may be better combined with the main guide, similar to how we currently have it. would love to know how the others think about this point!
    • Webpack page makes sense to me to keep separate if this is something fewer people use. Maybe create a complete setup guide so they can follow a guide from top to bottom.

Pages Router

  • This page includes a "Hybrid apps" section (Pages + App Router), but the App Router guide doesn't. Is there a specific reason behind this?
  • There's also a "Manually capture exceptions" section we only have on this page. Is there a specific reason behind this?

Webpack

  • I like that you put everything Webpack-relevant here; looks good
  • As mentioned above, it might help users if we expand this into a full setup guide

@sergical
Copy link
Member Author

@inventarSarah first of all, i really appreciate you taking the time and reviewing and writing such thoughtful feedback, you're awesome!

Wizard feedback should be addressed, let me know if it's closer to what you're thinking. I agree that the checklist is a bit vanity right now, I instrumented some basic event tracking for it to see if visitors will find it valuable, if not, it's an easy revert, but I do like the individual callouts with deeplinks to product for users to familiarize with parts of Sentry they might have not been familiar with.

I think i got manual setup in a state that matches the wizard end state, let me know what you think.

I did set Logs and Traces as enabled by default. I understand there were issues with having everything enabled by default that was eating at User's PAYG budget which is no bueno, my guess is it was Session Replay since there are only 50 in all plans, the rest of the features should with their configs (tracing at 10%, logs with 5 gb out of the box) should be fine and we give users a next step to learn more about the configuration.

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.

3 participants