-
-
Notifications
You must be signed in to change notification settings - Fork 4.5k
ref(onboarding): Split apple onboarding docs #102382
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
ref(onboarding): Split apple onboarding docs #102382
Conversation
| import {crashReport} from 'sentry/gettingStartedDocs/apple/macos/crashReport'; | ||
| import {profiling} from 'sentry/gettingStartedDocs/apple/macos/profiling'; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bug: ios/index.tsx incorrectly imports crashReport and profiling from apple/macos instead of apple/ios.
Severity: HIGH | Confidence: 1.00
🔍 Detailed Analysis
The ios/index.tsx file incorrectly imports crashReport and profiling from sentry/gettingStartedDocs/apple/macos/ instead of sentry/gettingStartedDocs/apple/ios/. This causes iOS developers to be presented with macOS-specific documentation for these features, which may contain platform-specific APIs or SDK behaviors that are not applicable to iOS, leading to incorrect guidance during onboarding.
💡 Suggested Fix
Update the import paths for crashReport and profiling in static/app/gettingStartedDocs/apple/ios/index.tsx to correctly reference sentry/gettingStartedDocs/apple/ios/ if iOS-specific files exist, or align with the intended platform-specific structure.
🤖 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: static/app/gettingStartedDocs/apple/ios/index.tsx#L5-L6
Potential issue: The `ios/index.tsx` file incorrectly imports `crashReport` and
`profiling` from `sentry/gettingStartedDocs/apple/macos/` instead of
`sentry/gettingStartedDocs/apple/ios/`. This causes iOS developers to be presented with
macOS-specific documentation for these features, which may contain platform-specific
APIs or SDK behaviors that are not applicable to iOS, leading to incorrect guidance
during onboarding.
Did we get this right? 👍 / 👎 to inform future reviews.
Contributes to https://linear.app/getsentry/issue/TET-864/introduce-folders-for-onboarding-platforms