Skip to content

feat(component): Create new component for feature information in quick start guides#16855

Draft
inventarSarah wants to merge 10 commits intomasterfrom
smi/quick-start/clean-up-includes
Draft

feat(component): Create new component for feature information in quick start guides#16855
inventarSarah wants to merge 10 commits intomasterfrom
smi/quick-start/clean-up-includes

Conversation

@inventarSarah
Copy link
Collaborator

DESCRIBE YOUR PR

Background:
In our quick start guides, we have two Expandables that explain Sentry features:

  • "Do you want to learn more about these features?"
  • "Need help locating the captured errors in your Sentry project?"

I created these as PlatformIncludes, which led to:

  • inconsistency because listed features didn't always match the actual onboarding options
  • multiple files containing the same content
  • updating feature descriptions or adding a new feature required editing multiple files

Changes:
Created a new component that

  • centralizes feature descriptions in one file
  • supports "learn more" and "find in Sentry" content types
  • works across languages and platforms (it is not JS-specific)
  • makes it easier to add new features or update descriptions/links etc

I updated all the quick start guides to use the new include & component and removed the old PlatformInclude files.

closes: #16320

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

@vercel
Copy link

vercel bot commented Mar 10, 2026

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

Project Deployment Actions Updated (UTC)
develop-docs Ready Ready Preview, Comment Mar 10, 2026 2:05pm
sentry-docs Ready Ready Preview, Comment Mar 10, 2026 2:05pm

Request Review

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.

Update Quick Start guide includes

1 participant