ref(apple): restructure install via SPM#18353
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
| </Alert> | ||
|
|
||
| ## SentryObjC | ||
| ## SentryObjC (Objective-C) |
There was a problem hiding this comment.
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:34docs/platforms/apple/common/install/index.mdx:17
Did we get this right? 👍 / 👎 to inform future reviews.
|
|
||
| ### 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`: | ||
|
|
There was a problem hiding this comment.
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.
DESCRIBE YOUR PR
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes: