Skip to content

docs(apple): Document hinge breadcrumbs for foldable devices - #20209

Open
itaybre wants to merge 1 commit into
masterfrom
apple-hinge-breadcrumbs
Open

itaybre wants to merge 1 commit into
masterfrom
apple-hinge-breadcrumbs

Conversation

@itaybre

@itaybre itaybre commented Oct 23, 2026

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

The Cocoa SDK adds a device.event breadcrumb when the hinge of a foldable device, such as iPhone Duo, opens, closes, or reaches the fully open or closed position. This adds the new automatic breadcrumb to the Apple list of automatic breadcrumbs. It requires iOS 27.1 or later.

SDK change: getsentry/sentry-cocoa#9426 (alternative implementation in getsentry/sentry-cocoa#9433).

IS YOUR CHANGE URGENT?

  • Urgent deadline (GA date, etc.): YYYY-MM-DD
  • Other deadline: YYYY-MM-DD
  • No deadline: 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 supplied a deadline.

PRE-MERGE CHECKLIST

  • 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

@vercel

vercel Bot commented Oct 23, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
sentry-docs Ready Ready Preview Oct 23, 2026 6:13pm UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Oct 23, 2026 6:13pm UTC

Request Review

@github-actions github-actions Bot added the Priority: Normal Docs review has no urgent deadline label Oct 23, 2026
@cursor

cursor Bot commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

The change adds one automatic breadcrumb line to published Apple pages. An issue escalates when those pages 404 or MDX runtime warnings appear. Load counts on the Apple breadcrumbs URLs show whether readers still reach the page.

Services: sentry-docs.

Mention @change-monitor in a comment to update the plan.

Plan

What changed

Apple breadcrumbs pages now list hinge state changes on foldable devices. The line requires iOS 27.1 or later. This change ships when sentry-docs deploys. The Vercel Production project and the runtime filter key both name sentry-docs. develop-docs is not a ship target. This include is product docs content only.

Risk

A broken MDX include can 404 the Apple breadcrumbs pages. Static generation can fail for those URLs. Inherited iOS, macOS, tvOS, visionOS, and watchOS pages share the include. Other platform breadcrumb includes share the same PlatformContent renderer. Readers then miss the documented hinge behavior.

Intended effect

This is a docs edit. No metric increments when the new hinge line appears. The published Apple and iOS breadcrumbs pages currently omit the hinge line. After deploy those pages should list hinge state changes. Absent means the published HTML still omits that line while page loads continue.

Signal Baseline Window Rule Source
Hinge line on published Apple breadcrumbs HTML Absent on Apple and iOS pages Fetched 2026-10-23T18:08:00Z The hinge line must appear. Absent if those pages still omit it. https://docs.sentry.io/platforms/apple/enriching-events/breadcrumbs/ and https://docs.sentry.io/platforms/apple/guides/ios/enriching-events/breadcrumbs/

Page loads on the changed URLs only show that the pages still render. They do not prove the new line is live.

Regression watch

Watch Apple section 404s, MDX missing-file warnings, and breadcrumbs page-load share. The 404 metric stores only the first two path segments. It covers the Apple section, not the breadcrumbs page alone.

Traffic on the changed URLs is low. Do not treat a few-hour zero as a regression.

Signal Baseline Window Rule Source
Apple section 404 rate 24h 3 404s / 472 page loads = 0.64%. 48h 3 / 878 = 0.34%. 7d 4 / 2771 = 0.14%. Band 0-0.7% 24h 2026-10-22T18:08:00Z to 2026-10-23T18:08:00Z. 48h 2026-10-21T18:08:00Z to 2026-10-23T18:08:00Z. 7d 2026-10-16T18:08:00Z to 2026-10-23T18:08:00Z Hold in 0-0.7%. Escalate if the rate rises above 0.7% Sentry org sentry, project docs, production. 404s: metric.name:docs.page.not_found AND sentry.environment:production AND requested_path:platforms/apple. Page loads: metric.name:docs.page.load AND sentry.environment:production AND path:/platforms/apple/*
MDX missing-file warning 0 logs in 24h and 48h. Share 0 / 472 Apple page loads 24h 2026-10-22T18:08:00Z to 2026-10-23T18:08:00Z. 48h 2026-10-21T18:08:00Z to 2026-10-23T18:08:00Z Hold at 0. Escalate if the warning appears Sentry org sentry, project docs, production logs. Query sentry.environment:production AND message:"*MDX file not found at runtime*"
Apple Cocoa breadcrumbs page-load share 48h 7 loads / 878 Apple page loads = 0.80%. 7d 14 / 2771 = 0.51%. Band 0.5-0.8% 48h 2026-10-21T18:08:00Z to 2026-10-23T18:08:00Z. 7d 2026-10-16T18:08:00Z to 2026-10-23T18:08:00Z Hold in 0.5-0.8% of Apple page loads. Escalate if a 48h window stays at 0 while Apple page loads hold Sentry org sentry, project docs, production. Query metric.name:docs.page.load AND sentry.environment:production AND path:"*apple*" AND path:"*breadcrumbs*". Sum Cocoa paths under /platforms/apple/. Exclude /platforms/dotnet/

If the 404 rate rises, inspect MDX warnings and the Apple breadcrumbs URLs first.

Not observable

Pageload and navigation traces for these URLs returned no rows. Two queries used url.path and url.full with span.op:[pageload,navigation].

Client error events are not sliced by page URL. The transaction name is the catch-all route /:path*?. A URL filter that returns 0 is not a baseline.

Get Slack DMs about this change: cursor.com/automations/rollouts

@coolguyzone coolguyzone left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LG, thanks for updating.

This branch was successfully deployed

1 active deployment
Preview – sentry-docs — bd1a9aeb Deployed Oct 23, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Normal Docs review has no urgent deadline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants