Skip to content

docs(apple): Add Hints API documentation - #19319

Open
itaybre wants to merge 1 commit into
masterfrom
itay/apple-hints-docs
Open

docs(apple): Add Hints API documentation#19319
itaybre wants to merge 1 commit into
masterfrom
itay/apple-hints-docs

Conversation

@itaybre

@itaybre itaybre commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Add documentation for the new Hints API in sentry-cocoa (9.28.0+). This follows the same structure used by other SDKs (Go, JS, Python) for documenting hints.

  • Add "Event Hints" and "Using Hints" sections to the filtering page with beforeSendWithHint / beforeBreadcrumbWithHint examples
  • Create before-send-hint/apple.mdx and breadcrumb-hints/apple.mdx platform includes
  • Add beforeSendWithHint and beforeBreadcrumbWithHint to the options page
  • Fix misleading hint references on the breadcrumbs page and link to the new hints docs

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+

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 supplied a deadline.

Thanks in advance for your help!

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

🤖 Generated with Claude Code

https://claude.ai/code/session_01BvkWRXpuQwgPK4mF59yssq

Document the new Hints API for sentry-cocoa (9.28.0+), including
beforeSendWithHint and beforeBreadcrumbWithHint callbacks, hint
properties, custom hint values, and passing hints to capture methods.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BvkWRXpuQwgPK4mF59yssq
@vercel

vercel Bot commented Sep 9, 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 Sep 9, 2026 3:40pm UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Sep 9, 2026 3:40pm UTC

Request Review

@github-actions github-actions Bot added the Priority: Normal Docs review has no urgent deadline label Sep 9, 2026
@codeowner-assignment
codeowner-assignment Bot requested a review from a team September 9, 2026 15:28
@itaybre
itaybre marked this pull request as ready for review September 9, 2026 15:39
@codeowner-assignment
codeowner-assignment Bot requested a review from a team September 9, 2026 15:40
@linear-code

linear-code Bot commented Sep 9, 2026

Copy link
Copy Markdown

COCOA-1895

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