ISS-160270: Restructure mobile SDK documentation for React Native SDK #223
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 [email protected]. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| @@ -1,16 +1,17 @@ | |||
| This section describes the process of integrating the DevRev SDK with your React Native app. | |||
|
|
|||
| ## Installation | |||
| ## Quickstart Guide | |||
There was a problem hiding this comment.
🚫 [EkLine]
'Quickstart Guide' should use sentence-style capitalization. (EK00037)
| @@ -107,14 +116,14 @@ | |||
| For scenarios where custom handling is needed, links from the support chat can be captured with the following method: | |||
|
|
|||
| ```typescript | |||
| DevRevSDK.setInAppLinkHandler((url) => { | |||
| DevRev.setInAppLinkHandler((url) => { | |||
| // Perform an action here. | |||
| }); | |||
| ``` | |||
|
|
|||
| If a custom handler is not defined, all external and in-app links from the support chat will open using the system's default browser, such as Chrome. | |||
There was a problem hiding this comment.
Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
| If a custom handler is not defined, all external and in-app links from the support chat will open using the system's default browser, such as Chrome. | |
| If a custom handler is not defined, all external and in-app links from the support chat open using the system's default browser, such as Chrome. |
There was a problem hiding this comment.
Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
There was a problem hiding this comment.
Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
PranithaShetty
force-pushed
the
feature/ISS-160270-restructure-mobile-sdk-documentation-for-react-native
branch
from
60e0cb1 to
6ad86fa
Compare
…cumentation-for-react-native
| @@ -210,25 +219,25 @@ To stop a timer, use the following method: | |||
| DevRev.stopTimer(name: string, properties: Map<string, string>) | |||
| ``` | |||
|
|
|||
| ### Screen tracking | |||
| #### Screen tracking | |||
|
|
|||
| 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: | |||
There was a problem hiding this comment.
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: | |
| The DevRev SDK offers automatic screen tracking to help you understand how users go through your app. Although view controllers are automatically tracked, you can manually track screens using the following method: |
| @@ -281,7 +290,7 @@ | |||
| const messageJson = notificationPayload["message"]; | |||
| DevRevSDK.processPushNotification(JSON.stringify(messageJson)); | |||
| ``` | |||
| #### iOS | |||
| ##### iOS | |||
|
|
|||
| 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. | |||
There was a problem hiding this comment.
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. | |
| On iOS devices, you must pass the received push notification payload to the DevRev SDK for processing. The SDK handles the notification and executes the necessary actions. |
| ``` | ||
|
|
||
| ## Troubleshooting | ||
| - **Issue**: Support chat won't show. |
There was a problem hiding this comment.
Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
| - **Issue**: Support chat won't show. | |
| - **Issue**: Support chat doesn't show. |
| **Solution**: The DevRev SDK reports all errors in the console using Apple's Unified Logging System. Look for error messages in the subsystem `ai.devrev.sdk`. | ||
|
|
||
|
|
||
| ## Migration Guide |
There was a problem hiding this comment.
🚫 [EkLine]
'Migration Guide' should use sentence-style capitalization. (EK00037)
| ## Migration Guide | ||
| This guide and chart should help facilitate the transition from the legacy UserExperior SDK to the new DevRev SDK in your React Native application, providing insights into feature equivalents and method changes. | ||
|
|
||
| ### Feature Equivalence Chart |
There was a problem hiding this comment.
🚫 [EkLine]
'Feature Equivalence Chart' should use sentence-style capitalization. (EK00037)
|
This PR was closed as the changes in this PR has been done in the PR ISS-158592: Modularize the mobile SDK documentation(#221). |
This PR restructures the React Native SDK documentation.