chore(android): Update feedback docs to use new Sentry.feedback() API#17631
Open
chore(android): Update feedback docs to use new Sentry.feedback() API#17631
Conversation
Switch all Android user feedback examples from the old showUserFeedbackDialog/captureFeedback APIs to the new Sentry.feedback().show() and Sentry.feedback().capture() entry points. Drop the SentryUserFeedbackButton widget section entirely and add Builder-based custom form and per-form shake-to-show documentation. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
Comment on lines
1
to
3
| ```kotlin {tabTitle:Kotlin} | ||
| import io.sentry.Sentry | ||
| import io.sentry.protocol.Feedback |
There was a problem hiding this comment.
Bug: The Java SDK documentation for user feedback incorrectly defaults to showing a Kotlin code example instead of Java due to reordered code blocks.
Severity: LOW
Suggested Fix
In platform-includes/user-feedback/sdk-api-example/java.mdx, restore the original order of the code blocks by placing the Java snippet before the Kotlin snippet. This will ensure the Java code is the default view on the Java documentation page.
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: platform-includes/user-feedback/sdk-api-example/java.mdx#L1-L3
Potential issue: A change intended to reorder code snippets for Android documentation
has unintentionally altered the
`platform-includes/user-feedback/sdk-api-example/java.mdx` file. This file is used in
the pure Java SDK documentation. As a result, the Kotlin code example is now displayed
by default on the Java documentation page for user feedback, which can be confusing for
users seeking Java-specific code.
Did we get this right? 👍 / 👎 to inform future reviews.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Switch all Android user feedback documentation from the old
showUserFeedbackDialog/captureFeedbackAPIs to the newSentry.feedback().show()andSentry.feedback().capture()entry points. Drop theSentryUserFeedbackButtonwidget section and renameSentryUserFeedbackDialogreferences toSentryUserFeedbackForm.New API examples
All code examples now use
Sentry.feedback()as the entry point —show()for displaying the built-in form andcapture()for submitting feedback from custom UI.Builder-based custom form
Added a "Custom Form" subsection showing
SentryUserFeedbackForm.Builderfor full control over theme, associated event, and per-form options.Per-form shake-to-show
Added documentation for enabling shake detection on individual form instances via
Builder.configurator { it.isUseShakeGesture = true }, as an alternative to the global shake setting.Depends on getsentry/sentry-java#5353 and getsentry/sentry-java#5366.
Closes getsentry/sentry-java#5306