Skip to content

docs(apple): restructure install docs and add SentryObjC#17926

Draft
philprime wants to merge 4 commits into
masterfrom
philprime/apple-install-restructure-sentryobjc
Draft

docs(apple): restructure install docs and add SentryObjC#17926
philprime wants to merge 4 commits into
masterfrom
philprime/apple-install-restructure-sentryobjc

Conversation

@philprime
Copy link
Copy Markdown
Member

Restructures the Apple SDK installation docs to clearly separate pre-compiled
and compile-from-source products, and documents the new SentryObjC wrapper
(shipping in 9.16.1) for Objective-C/ObjC++ projects that can't use Clang modules.

SPM page now has three sections: Pre-compiled (Recommended) for Sentry,
Sentry-Dynamic, SentrySwiftUI; Compile from Source for SentrySPM and
NoUIFramework; and SentryObjC with installation and configuration examples.

Manual Install page adds SentryObjC.xcframework.zip and
SentryObjC-Dynamic.xcframework.zip to the download list with usage guidelines.

Install index adds an info callout directing ObjC++/no-modules users to the
SentryObjC section.

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

Reorganize the SPM page into Pre-compiled, Compile from Source, and
SentryObjC sections so users can quickly find the right product. Add
SentryObjC xcframeworks to the manual install page and a callout on
the install index for ObjC++/no-modules projects.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented May 29, 2026

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

Project Deployment Actions Updated (UTC)
sentry-docs Ready Ready Preview, Comment May 29, 2026 2:01pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Preview May 29, 2026 2:01pm

Request Review

@codeowner-assignment codeowner-assignment Bot requested a review from a team May 29, 2026 13:38
philprime and others added 2 commits May 29, 2026 15:40
SentryObjC via SPM compiles from source; only the dynamic xcframework
is available pre-compiled. Remove the non-existent static xcframework
and clarify the SPM product compiles from source.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
SwiftUI view performance tracking is now included in the main Sentry
product. Mark SentrySwiftUI as deprecated in both SPM and manual
install pages.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Comment thread docs/platforms/apple/common/install/swift-package-manager.mdx Outdated
Copy link
Copy Markdown
Contributor

@itaybre itaybre left a comment

Choose a reason for hiding this comment

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

LGTM, with some comments

SentryObjC
</PlatformLink>{" "}
section for a pure Objective-C integration that doesn't require Swift headers
or `@import`.
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.

l: Adding the name for @import, wdyt?

Suggested change
or `@import`.
or semantic imports (`@import`).

- `Sentry-WithoutUIKitOrAppKit.xcframework.zip` — Static framework without UIKit or AppKit linking and related features

**SentryObjC (pure Objective-C interface):**
- `SentryObjC-Dynamic.xcframework.zip` — Dynamic framework
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.

l: Not specifically linked to your change, but should we mention arm64e variants?

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