Skip to content

feat(docs): Apply new quick start template to Apple quick start guides - #20004

Open
sentry-junior[bot] wants to merge 3 commits into
masterfrom
docs/quickstart-template-apple
Open

sentry-junior[bot] wants to merge 3 commits into
masterfrom
docs/quickstart-template-apple

Conversation

@sentry-junior

@sentry-junior sentry-junior Bot commented Oct 15, 2026 •

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Applies the quick start template from #19295 (Ember) to the shared Apple quick start (includes/apple-platform-getting-started.mdx), which renders for the iOS, macOS, tvOS, visionOS, and watchOS guides. All pages keep their single-column layout.

  • Removes the onboarding option checkboxes and ___PRODUCT_OPTION___ markers. iOS keeps the setup wizard and a manual installation path.
  • Explains what the wizard doesn't include (Session Replay, SwiftUI view instrumentation, and application-specific logs and metrics), and directs readers back to Configure and the remaining steps to complete setup. Documents the wizard 9.0.0 generated-code corrections for current SDKs.
  • Adds SDK and OS prerequisites, SPM product/target selection, main-thread initialization, production configuration guidance, and a complete SwiftUI example.
  • Configure names only the features each OS supports:
    • iOS: Tracing, Profiling, Session Replay, Logs
    • macOS: Tracing, Profiling, Logs
    • tvOS, visionOS, watchOS: Tracing, Logs
    • All: Error Monitoring and Application Metrics; watchOS captures handled errors without crash detection
  • Adds a manual test transaction and explains root-span requirements for automatic child spans and trace-lifecycle profiling, including the extra instrumentation needed on macOS and watchOS.
  • Logs are sent through SentrySDK.logger on all supported Apple platforms, including watchOS. SDK 9.27+ manual logging doesn't require an enable flag; older SDK setup remains documented. Updates the linked feature, logging integration, and configuration pages to match.
  • Application Metrics are enabled by default but recorded explicitly. Corrects the experimental introduction to SDK 9.2, retains the stable milestone of 9.12, documents the separate SentryObjC metrics API available since 9.16, and fixes counter examples that passed unsupported units. Documents filtering for SDK 9.27+, where the legacy enable flag no longer gates capture.
  • Removes the outdated iOS/tvOS 16 Replay restriction and updates the linked feature pages.
  • Adds Send Logs, Send Application Metrics, and Upload Debug Symbols steps. Distinguishes handled-error verification from crash testing and explains macOS uncaught-exception behavior.

Validation

  • Checked against sentry-cocoa 9.31.0 source and sentry-wizard v9.0.0/Homebrew configuration.
  • Compiled all 19 changed MDX files with the documentation compiler.
  • Rendered all five platform guides locally and checked platform-specific snippets, code tabs, and in-page anchors.
  • Validated 47 linked destinations and fragments.
  • Passed trailing-slash lint and git diff --check; the quickstart and updated setup/options includes pass Prettier. Existing formatting differences in other linked pages were left outside the content changes.

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+

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

via shannon.anahata.

--

View Junior Session [Sentry]

sentry-junior Bot and others added 2 commits October 15, 2026 01:12
Co-Authored-By: Shannon Anahata <shannon.anahata@sentry.io>
Co-Authored-By: Shannon Anahata <shannon.anahata@sentry.io>
@vercel

vercel Bot commented Oct 15, 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 29, 2026 12:36am UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Oct 29, 2026 12:36am UTC

Request Review

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

cursor Bot commented Oct 15, 2026 •

Copy link
Copy Markdown
Contributor

The change rewrites Apple getting-started guides to a numbered setup flow. The plan checks client errors, sampled page volume, and page duration on those guides. An issue escalates when client errors rise or sampled volume falls.

Services: sentry-docs.

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

Plan

What changed

Apple getting-started pages now show a numbered Install, Configure, and Verify flow. They no longer show product-option checkboxes. The iOS page still shows the setup wizard and a manual path. macOS, tvOS, visionOS, and watchOS each show their own SDK snippets. The change is live after sentry-docs deploys.

Risk

A StepConnector or code-tab failure can hide the setup steps. Readers then cannot copy a working SDK snippet. A wrong platform gate can show iOS-only wizard text on other Apple platforms. Extra snippets can slow the iOS guide. watchOS no longer enables logs in the getting-started snippet.

Intended effect

This rewrite does not emit a success counter for the new template. Record intended effect as unknown unless the new heading id appears in traffic. The new heading id is verify-your-setup. A stay at zero does not prove the heading is missing.

Signal Baseline Window Source Rule
Sampled pageload and navigation count for url.full:*#verify-your-setup* 0 spans 2026-10-08T14:49:48Z to 2026-10-15T14:49:48Z Sentry sentry/docs traces. Query: environment:production project:docs span.op:[pageload,navigation] url.full:*#verify-your-setup* A rise above 0 confirms the new heading. Do not treat a hold at 0 as absent.

Absent looks like this: Apple getting-started volume still holds, and url.full:*#verify-your-setup* stays at 0. That result is unknown, not failed.

Regression watch

Watch client errors and sampled traffic on the pages that include this file. Split the volume signal by the iOS path and the macOS path. iOS is the heavy wizard path. Trace volume is sampled at 30 percent. Pair error counts with that sampled volume. Transaction name is /:path*?. Filter by url.full.

Signal Baseline Window Source Rule
Error events on Apple getting-started URLs 2 events per 24h. 9 events per 7d. Titles: Event: Event \Event` (type=error) captured as promise rejectionat 1 per 24h and 8 per 7d.TypeError: Failed to fetch (insights.algolia.io)` at 1 per 24h and 1 per 7d. 2026-10-14T14:49:48Z to 2026-10-15T14:49:48Z and 2026-10-08T14:49:48Z to 2026-10-15T14:49:48Z Sentry sentry/docs errors. Query: environment:production AND (http.url:"*/platforms/apple/" OR http.url:"*/platforms/apple/guides/ios/" OR http.url:"*/platforms/apple/guides/macos/" OR http.url:"*/platforms/apple/guides/tvos/" OR http.url:"*/platforms/apple/guides/visionos/" OR http.url:"*/platforms/apple/guides/watchos/") Hold at 0-2 events per 24h. Escalate if the 24h count rises above 2, or if a new title cites StepConnector, code tabs, or Expandable.
Sampled pageload and navigation count for iOS getting-started 53 spans per 24h. 50 spans in the prior 24h. 250 spans per 7d, mean 36 per 24h. Band 36-53 spans per 24h. 2026-10-14T14:49:48Z to 2026-10-15T14:49:48Z, 2026-10-13T14:49:48Z to 2026-10-15T14:49:48Z, and 2026-10-08T14:49:48Z to 2026-10-15T14:49:48Z Sentry sentry/docs traces. Query: environment:production project:docs span.op:[pageload,navigation] url.full:*/platforms/apple*. Read url.full https://docs.sentry.io/platforms/apple/guides/ios/. Hold in 36-53 sampled spans per 24h. Escalate if the count falls below 36.
Sampled pageload and navigation count for macOS getting-started 13 spans per 24h. 43 spans per 7d, mean 6 per 24h. Band 6-13 spans per 24h. 2026-10-14T14:49:48Z to 2026-10-15T14:49:48Z and 2026-10-08T14:49:48Z to 2026-10-15T14:49:48Z Same traces query. Read url.full https://docs.sentry.io/platforms/apple/guides/macos/. Hold in 6-13 sampled spans per 24h. Escalate if the count falls below 6.
p75 span duration for iOS getting-started 2361ms per 24h. 2601ms per 7d. Band 2360-2601ms. 2026-10-14T14:49:48Z to 2026-10-15T14:49:48Z and 2026-10-08T14:49:48Z to 2026-10-15T14:49:48Z Same traces query. Metric p75(span.duration) on https://docs.sentry.io/platforms/apple/guides/ios/. Hold in 2360-2601ms. Escalate if p75 rises above 2601ms.

Also read https://docs.sentry.io/platforms/apple/ from the same traces query. That URL shared this include and had 23 spans per 24h and 70 spans per 7d.

Not observable

LCP for these pages returned no value, so first-paint impact is not measurable here. tvOS getting-started had 0 sampled spans in 7d, so that slice has no duration baseline. visionOS and watchOS had 3 sampled spans each in 7d, so those slices cannot support a latency rule. Telemetry cannot show whether each platform rendered the correct snippet. Telemetry cannot show that the product-option checkboxes are gone.

Document wizard omissions and return readers to the remaining setup steps. Align Apple quickstarts and linked feature, logging, and metrics guidance with the Cocoa SDK, and add tracing, symbol upload, and verification steps.

This branch was successfully deployed

1 active deployment
Preview – sentry-docs — 0f97740f Deployed Oct 29, 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.

1 participant