PLuG SDK reorganization #182
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]. |
|
Published docs preview URL: https://devrev-preview-4a01d7cf-9eea-4ede-b6a1-5a50fcb00c5e.docs.buildwithfern.com |
|
Published docs preview URL: https://devrev-preview-73217083-10af-464b-9793-fcf181ad2231.docs.buildwithfern.com |
|
Published docs preview URL: https://devrev-preview-43f88e01-02bd-44e5-b535-61e508cf0861.docs.buildwithfern.com |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| The DevRev SDK must be configured before you can use any of its features. | ||
| </Callout> | ||
|
|
||
| The SDK will be ready for use once you execute the following configuration method. |
There was a problem hiding this comment.
Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
| The SDK will be ready for use once you execute the following configuration method. | |
| The SDK is ready for use once you execute the following configuration method. |
| The identification function should be placed appropriately in your app after the user logs in. If you have the user information available at app launch, call the function after the `DevRev.configure(appID:)` method. | ||
|
|
||
| <Callout intent="note"> | ||
| On iOS, if you haven't previously identified the user, the DevRev SDK will automatically create an anonymous user for you immediately after the SDK is configured. |
There was a problem hiding this comment.
Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
| On iOS, if you haven't previously identified the user, the DevRev SDK will automatically create an anonymous user for you immediately after the SDK is configured. | |
| On iOS, if you haven't previously identified the user, the DevRev SDK automatically creates an anonymous user for you immediately after the SDK is configured. |
| }); | ||
| ``` | ||
|
|
||
| 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. |
|
|
||
| ### 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: |
| ``` | ||
| #### 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 then handles the notification and executes the necessary actions. |
|
|
||
| Configure the SDK in the `AppDelegate.application(_:didFinishLaunchingWithOptions:)` method. | ||
|
|
||
| - SwiftUI apps |
There was a problem hiding this comment.
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
| - SwiftUI apps | |
| - SwiftUI apps. |
| The identification function should be placed appropriately in your app after the user logs in. If you have the user information available at app launch, call the function after the `DevRev.configure(appID:)` method. | ||
|
|
||
| <Callout intent="note"> | ||
| If you haven't previously identified the user, the DevRev SDK will automatically create an anonymous user for you immediately after the SDK is configured. |
There was a problem hiding this comment.
Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
| If you haven't previously identified the user, the DevRev SDK will automatically create an anonymous user for you immediately after the SDK is configured. | |
| If you haven't previously identified the user, the DevRev SDK automatically creates an anonymous user for you immediately after the SDK is configured. |
|
|
||
| ### 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: |
|
|
||
| ### Handle push notifications | ||
|
|
||
| To properly handle push notifications, implement the following method, typically in either the `UNUserNotificationCenterDelegate.userNotificationCenter(_:didReceive:)` or `UIApplicationDelegate.application(_:didReceiveRemoteNotification:fetchCompletionHandler:)`: |
There was a problem hiding this comment.
📝 [EkLine] reported by reviewdog 🐶
Remove 'properly ' if it's not important to the meaning of the statement. (EK00006)
| To properly handle push notifications, implement the following method, typically in either the `UNUserNotificationCenterDelegate.userNotificationCenter(_:didReceive:)` or `UIApplicationDelegate.application(_:didReceiveRemoteNotification:fetchCompletionHandler:)`: | |
| To handle push notifications, implement the following method, typically in either the `UNUserNotificationCenterDelegate.userNotificationCenter(_:didReceive:)` or `UIApplicationDelegate.application(_:didReceiveRemoteNotification:fetchCompletionHandler:)` |
| - **Issue**: How does the DevRev SDK handle errors? | ||
| **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`. | ||
|
|
||
| - **Issue**: Support chat won't show. |
fern/docs/pages/plug-sdk/index.mdx
Outdated
|
Published docs preview URL: https://devrev-preview-d81081dd-2a4e-4df0-a6dd-34ffa9152b36.docs.buildwithfern.com |
|
Published docs preview URL: https://devrev-preview-c6ad2c48-73fc-4ef4-bcf9-0aa34d820664.docs.buildwithfern.com |
|
Published docs preview URL: https://devrev-preview-247d5ede-761a-4a69-982a-8cdd6c286752.docs.buildwithfern.com |
…pi-docs into bc/sdks-ISS-159977
|
Published docs preview URL: https://devrev-preview-b4e5ff55-7e1d-4914-9912-d23de7162711.docs.buildwithfern.com |
|
Published docs preview URL: https://devrev-preview-c95545dc-33f1-47da-a0f3-5a47283a3d7b.docs.buildwithfern.com |
|
Published docs preview URL: https://devrev-preview-1aca4aa7-91db-48d3-93b5-e7a9ec97bac2.docs.buildwithfern.com |
…pi-docs into bc/sdks-ISS-159977
|
Published docs preview URL: https://devrev-preview-626b4734-79aa-43ee-a486-497f63ce83d8.docs.buildwithfern.com |
|
Published docs preview URL: https://devrev-preview-c7e36936-7945-4d3d-bb1a-982ad467013a.docs.buildwithfern.com |
ISS-159977