Incomplete and inaccurate User Feedback usage documentation

[lhunath]

SDK

Apple SDK

Description

The new User Feedback user interface and widget is poorly documented. Please thoroughly review it.

A few pointers:

1. It is unclear what the requirements are to ensure the widget can display.
   • It is unclear how autoinject works and whether the widget will show for apps with no specific configuration or whether something needs to be enabled/added.
   • "Injects the Feedback widget into the application when the integration is added. Default: true" does this mean I need to add the integration somehow or every app will suddenly get a widget?
2. The Swift example code is malformed:
   • options.configureUserFeedback { config in
     • configureUserFeedback is an optional variable, not a function, it cannot be invoked as if a function. Perhaps this intends to suggest assignment.
     • Does simply assigning a non-null value to this variable cause a feedback widget to appear if autoinject is on?
   • options.showFormForScreenshots = true
     • There is no showFormForScreenshots on SentryOptions, perhaps this is referring to SentryUserFeedbackConfiguration?
3. It is unclear where the widget will display and how it will appear.
   • I cannot get the widget to appear, nor can I get it to trigger on showFormForScreenshots or useShakeGesture

In all, a very confusing and misleading API & documentation. As I am not an expert in what all is supposed to be possible & how with this API, kindly have someone with knowledge of the API thoroughly review the documentation & implementation to ensure that what is expected to be delivered is actually there & the documentation correctly describes it & it communicates clearly to people who do not know how this API works and how to use it, step-by-step, what is required to enable each use case, without jumping over steps or making assumptions & beginning from the start, with the requirements, not the API options.

Suggested Solution

No response