-
Notifications
You must be signed in to change notification settings - Fork 3
ISS-160289: Update the React Native SDK guide #195
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
ISS-160289: Update the React Native SDK guide #195
Conversation
🌟 EkLine ReviewerHello! I’m here to help improve your docs. I’ve reviewed your pull request, and left in-line suggestions for quick fixes. For details, visit the Analytics Page. For questions or feedback, please email support@ekline.io. |
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.
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.
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.
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.
Consider using 'go' instead of 'navigate'. (EK25033)
The DevRev SDK offers automatic screen tracking to help you understand how users navigate through your app. Although view controllers are automatically tracked, you can manually track screens using the following method: |
Published docs preview URL: https://devrev-preview-7cb517f7-e93b-42ae-aa58-85a2696a5dee.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-b935ef54-c695-457f-9eb0-bf0ba6e055ec.docs.buildwithfern.com |
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.
Approved with some suggestions.
@@ -90,7 +90,7 @@ DevRev.createSupportConversation() | |||
|
|||
### In-app link handling | |||
|
|||
In some instances, links opened from the support chat are displayed within the app rather than in a browser. You can manage whether the chat modal should close after a link is opened by using the following method: | |||
In certain cases, the links opened from the support chat are opened in the app instead of a browser. You can control whether the chat modal should be dismissed after the link is opened by calling the following method: |
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.
The revision has the problem that "opened" is repeated. I'd recommend sticking with the original phrasing of this line.
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.
There were a few issues in the original phrasing, we can try to rephrase the part where opened is duplicated.
In certain cases, the links opened from the support chat are opened in the app instead of a browser. You can control whether the chat modal should be dismissed after the link is opened by calling the following method: | |
In certain cases, tapping links in the support chat will open them in the app instead of a browser. You can control whether the chat modal screen should be dismissed after the link is opened by calling the following method: |
|`DevRev.pauseRecording()` | Pauses the ongoing session recording. | | ||
|`DevRev.resumeRecording()` | Resumes a paused session recording. | | ||
|`DevRev.startRecording()` | Start the session recording. | | ||
|`DevRev.stopRecording()` | Stop the session recording and uploads it to the portal. | |
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.
|`DevRev.stopRecording()` | Stop the session recording and uploads it to the portal. | | |
|`DevRev.stopRecording()` | Stop the session recording and upload it to the portal. | |
|`DevRev.stopRecording()` | Stop the session recording and uploads it to the portal. | | ||
|`DevRev.pauseRecording()` | Pause the ongoing session recording. | | ||
|`DevRev.resumeRecording()` | Resume a paused session recording. | | ||
|`DevRev.processAllOnDemandSessions()` | Stop the ongoing session recording and uploads all offline sessions on demand, including the current one.| |
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.
|`DevRev.processAllOnDemandSessions()` | Stop the ongoing session recording and uploads all offline sessions on demand, including the current one.| | |
|`DevRev.processAllOnDemandSessions()` | Stop the ongoing session recording and upload all offline sessions on demand, including the current one.| |
@@ -230,7 +231,7 @@ To receive push notifications, you need to configure your DevRev organization by | |||
### Register for push notifications | |||
|
|||
<Callout intent="note"> | |||
Push notifications require SDK configuration and user identification, whether unverified or anonymous, to ensure delivery to the correct user. | |||
Push notifications require that the SDK has been configured and the user has been identified, to ensure delivery to the correct user. |
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.
Push notifications require that the SDK has been configured and the user has been identified, to ensure delivery to the correct user. | |
To ensure delivery to the correct user, push notifications require that the SDK has been configured and the user has been identified. |
@@ -239,7 +240,7 @@ The DevRev SDK offers a method to register your device for receiving push notifi | |||
DevRevSDK.registerDeviceToken(deviceToken: string, deviceID: string) | |||
``` | |||
|
|||
On Android devices, the `deviceToken` should be the Firebase Cloud Messaging (FCM) token value, while on iOS devices, it should be the Apple Push Notification Service (APNS) token. | |||
On Android devices, the `deviceToken` should be the Firebase Cloud Messaging (FCM) token value, while on iOS devices, it should be the Apple Push Notification Service (APNs) token. |
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.
On Android devices, the `deviceToken` should be the Firebase Cloud Messaging (FCM) token value, while on iOS devices, it should be the Apple Push Notification Service (APNs) token. | |
On Android devices, the `deviceToken` must be the Firebase Cloud Messaging (FCM) token value. On iOS devices, it must be the Apple Push Notification Service (APNs) token. |
Published docs preview URL: https://devrev-preview-be2d89ef-79fa-42bf-8d29-856d20366ef5.docs.buildwithfern.com |
@bc-devrev - Worked on your suggestions. Please re-review. |
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.
One minor thing.
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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.
Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
On iOS devices, you must pass the received push notification payload to the DevRev SDK for processing. The SDK will then handle the notification and execute the necessary actions. |
Published docs preview URL: https://devrev-preview-fe600fbc-797c-44ce-8d4d-25cd9e66aac0.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-c116c4f0-b021-463d-8dfd-065dbf708dd9.docs.buildwithfern.com |
This PR updates the React Native SDK guide.