Skip to content

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

Merged
sfanahata merged 5 commits into
masterfrom
docs/quickstart-template-apple
Nov 9, 2026
Merged

sfanahata merged 5 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
  • Preserves the background-thread initialization FAQ in Troubleshooting and links to it from all five quickstarts.
  • 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 the 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.
  • Review follow-up: compiled all four updated MDX files and all five quickstarts; verified the inherited background-thread FAQ and its anchor for each platform.
  • 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 Nov 3, 2026 9:46pm UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Nov 3, 2026 9:46pm 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

Services awaiting deployment · Rollout details

Warning

Rollouts can't watch this change after it deploys: every data source for this team needs to be signed in again, so a check has no telemetry to read. Sign in to your data sources, or ask a team admin to.

Status Service Environment
⚪ Not deployed yet sentry-docs

Mention @rollout in a comment to update the plan.

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.

@philprime philprime left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM with some feedback

Co-authored-by: Philip Niedertscheider <phil.niedertscheider@sentry.io>
Restore the background-thread initialization FAQ in troubleshooting and link it from the quickstarts. Remove redundant UIKit imports and describe SentryObjC as a framework.
@sfanahata
sfanahata merged commit 27ce5b5 into master Nov 9, 2026
29 of 30 checks passed
@sfanahata
sfanahata deleted the docs/quickstart-template-apple branch November 9, 2026 19:06

This branch was successfully deployed

1 active deployment
Preview – sentry-docs — 1037b086 Deployed Nov 3, 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