Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(native): add view hierarchy docs #13191

Closed
wants to merge 1 commit into from

Conversation

JoshuaMoelans
Copy link
Member

@JoshuaMoelans JoshuaMoelans commented Apr 1, 2025

DESCRIBE YOUR PR

Related to getsentry/sentry-native#1191

Vercel Preview of the relevant page

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

Copy link

vercel bot commented Apr 1, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 1, 2025 2:24pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Apr 1, 2025 2:24pm
develop-docs ⬜️ Ignored (Inspect) Visit Preview Apr 1, 2025 2:24pm

Copy link

codecov bot commented Apr 1, 2025

Bundle Report

Changes will increase total bundle size by 228 bytes (0.0%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 10.61MB 234 bytes (0.0%) ⬆️
sentry-docs-client-array-push 9.45MB -6 bytes (-0.0%) ⬇️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.58MB -0.0%
../instrumentation.js -3 bytes 911.63kB -0.0%
9523.js -3 bytes 887.68kB -0.0%
../app/[[...path]]/page.js.nft.json 81 bytes 383.67kB 0.02%
../app/platform-redirect/page.js.nft.json 81 bytes 383.58kB 0.02%
../app/sitemap.xml/route.js.nft.json 81 bytes 381.56kB 0.02%
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 868.67kB -0.0%
static/chunks/8931-*.js -3 bytes 397.42kB -0.0%
server/middleware-*.js -5.55kB 1.0kB -84.74%
server/middleware-*.js 5.55kB 6.55kB 555.3% ⚠️
static/1aCgFbV_xo9eamyR2KKhG/_buildManifest.js (New) 578 bytes 578 bytes 100.0% 🚀
static/1aCgFbV_xo9eamyR2KKhG/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/w8yXt9AQyNOA8L5WFL6O6/_buildManifest.js (Deleted) -578 bytes 0 bytes -100.0% 🗑️
static/w8yXt9AQyNOA8L5WFL6O6/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️

Copy link
Collaborator

@supervacuus supervacuus left a comment

Choose a reason for hiding this comment

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

Do you think we should document this option? It does not make much sense to direct SDK users; it is primarily for downstream SDKs. If we document it here, we must signal the primary use case (something similar to "You will never have to set this yourself; a downstream SDK built on top of the Native SDK will usually provide the view hierarchy for you").

It would also be good to mention this in the header inline docs.

CC: @kahest

@JoshuaMoelans
Copy link
Member Author

@supervacuus Since the view-hierarchy inherently doesn't make a lot of sense in a Native setting, I think you're right about not needing it documented here. I'm fine with closing this PR.

@JoshuaMoelans
Copy link
Member Author

As the feature isn't meant to be native-user-facing, but rather as a functionality consumed by downstream SDKs, we opt to not document its use here.

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.

2 participants