Skip to content

ref(apple): restructure install via SPM#18353

Open
philprime wants to merge 1 commit into
masterfrom
philprime/apple-install-instructions
Open

ref(apple): restructure install via SPM#18353
philprime wants to merge 1 commit into
masterfrom
philprime/apple-install-instructions

Conversation

@philprime

Copy link
Copy Markdown
Member

DESCRIBE YOUR PR

  • Restructures to explain compile-from-source installation via SPM as the first and recommended approach
  • Structures the install page to the following table of content:
1. Sentry (Swift) (##)
  - Compile from Source (Recommended) (###)
  - Pre-compiled (###)
  - Building Without UIKit or AppKit (###)
    - Xcode (####)
  - Package.swift (####)
2. SentryObjC (Objective-C) (##)
  - Compile from Source (###)
  - Pre-compiled (###)
  - Additional Build Settings (###)
    - SentryObjC-Static (####)
  - Clang Modules Disabled / Objective-C++ (####)

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

@vercel

vercel Bot commented Jun 10, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
sentry-docs Ready Ready Preview, Comment Jun 10, 2026 8:47am
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Jun 10, 2026 8:47am

Request Review

@codeowner-assignment codeowner-assignment Bot requested a review from a team June 10, 2026 08:38
</Alert>

## SentryObjC
## SentryObjC (Objective-C)

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.

Bug: Renaming the SentryObjC heading broke existing anchor links (#sentryobjc) in other documentation files.
Severity: LOW

Suggested Fix

Update the PlatformLink components in manual-install.mdx and index.mdx. Change the to prop from .../#sentryobjc to .../#sentryobjc-objective-c to point to the new, correct anchor.

Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.

Location: docs/platforms/apple/common/install/swift-package-manager.mdx#L113

Potential issue: The heading `## SentryObjC` was renamed to `## SentryObjC
(Objective-C)`, which changed its auto-generated anchor from `#sentryobjc` to
`#sentryobjc-objective-c`. Existing links in `manual-install.mdx` and `index.mdx` still
reference the old anchor. As a result, these links no longer navigate to the correct
section on the page, instead sending the user to the top.

Also affects:

  • docs/platforms/apple/common/install/manual-install.mdx:34
  • docs/platforms/apple/common/install/index.mdx:17

Did we get this right? 👍 / 👎 to inform future reviews.

Comment on lines 120 to 130

### Installation
<Alert level="info">
SentryObjC embeds the full Sentry SDK. Do not link both `Sentry` and `SentryObjC` in the same target.
</Alert>

SentryObjC is available as both a compile-from-source SPM product and pre-compiled xcframeworks.
### Compile from Source

**Via SPM (compile from source):** In Xcode, add the Sentry package as described above and select the **`SentryObjC`** product.
In Xcode, add the Sentry package as described above and select the **`SentryObjC`** product.

With `Package.swift`:

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.

Bug: The SentryObjC configuration and initialization guide was removed, but other documentation still links to it.
Severity: MEDIUM

Suggested Fix

Restore the ### Configuration section with the Objective-C initialization code example (startWithConfigureOptions:) to swift-package-manager.mdx, or update the link in manual-install.mdx to point to a new or existing page that contains the correct SentryObjC configuration details.

Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.

Location: docs/platforms/apple/common/install/swift-package-manager.mdx#L120-L130

Potential issue: The `### Configuration` section, which contained the only Objective-C
initialization code example for `SentryObjCSDK`, was removed from the Swift Package
Manager installation guide. However, the manual installation guide still directs users
to this page for "configuration and initialization details." Users following this link
will find no guidance on how to initialize the SDK for Objective-C.

Also affects:

  • docs/platforms/apple/common/install/manual-install.mdx:34

Did we get this right? 👍 / 👎 to inform future reviews.

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.

1 participant