ISS-163750: Update the Android SDK guide #204
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-5ac7e879-af0f-4d9a-987a-e1e1d442a011.docs.buildwithfern.com |
fern/docs/pages/plug-sdk/android.mdx
Outdated
| @@ -53,8 +53,12 @@ After completing these steps in your `build.gradle` Groovy script, you should be | |||
|
|
|||
| ## Set up the DevRev SDK | |||
There was a problem hiding this comment.
How does this relate to the "Quickstart guide" section?
There was a problem hiding this comment.
@bc-devrev we'll be splitting the documentation for each platform to multiple child pages: https://app.devrev.ai/devrev/works/ISS-158597.
This PR is only bringing the latest changes from the source readme.
There was a problem hiding this comment.
@bc-devrev we have prepared the restructured documentation PR #223. Can we approve this one?
fern/docs/pages/plug-sdk/android.mdx
Outdated
| @@ -130,9 +155,9 @@ The identification function should be placed appropriately in your app after the | |||
| The `Identity` structure allows for custom fields in the user, organization, and account traits. These fields must be configured through the DevRev app before they can be utilized. For more information, refer to [Object customization](https://devrev.ai/docs/product/object-customization). | |||
| </Callout> | |||
|
|
|||
| ### Anonymous identification | |||
| #### Anonymous identification | |||
There was a problem hiding this comment.
Getting to H4 is an indication that there's too much content for a single page.
| @@ -248,7 +355,7 @@ The DevRev SDK also provides a support button, which can be integrated into your | |||
| app:layout_constraintBottom_toBottomOf="parent" | |||
| app:layout_constraintEnd_toEndOf="parent" /> | |||
| ``` | |||
| The support button can be customized using default parameters, enabling you to tailor its appearance to your application's design. | |||
| The support button can also accept default parameters like | |||
|
|
|||
| ```kotlin | |||
| android:src="@your_drawable_here" | |||
There was a problem hiding this comment.
Recommend combining these lines into a single codeblock rather than two with "and" between.
There was a problem hiding this comment.
As they are separate properties, I'd leave them as is.
fern/docs/pages/plug-sdk/android.mdx
Outdated
| @@ -345,31 +524,62 @@ The session recording feature is opt-out and is enabled by default. | |||
|
|
|||
| Here are the available methods to help you control the session recording feature: | |||
|
|
|||
| |Action |Kotlin (`DevRev`) |Java (`DevRevObservabilityExtKt`) | | |||
| |Kotlin |Java |Action | | |||
There was a problem hiding this comment.
This table doesn't fit on the page. Saving space is why DevRevObservabilityExtKt wasn't repeated in every row.
There was a problem hiding this comment.
I'd rather split them in two tables, one for Kotlin and one for Java. We should mention the full signature including the module name. @Yug2801 @bc-devrev
fern/docs/pages/plug-sdk/android.mdx
Outdated
| |Ends the session recording and uploads it to the portal. |stopRecording() |stopRecording(DevRev.INSTANCE); | | ||
| |Pauses the ongoing session recording. |pauseRecording() |pauseRecording(DevRev.INSTANCE); | | ||
| |Resumes a paused session recording. |resumeRecording() |resumeRecording(DevRev.INSTANCE); | | ||
| | DevRev.startRecording() | DevRevObservabilityExtKt.startRecording(DevRev.INSTANCE, context); | Starts the session recording. | |
There was a problem hiding this comment.
Surrounding the methods with backticks as they should would prevent the EkLine comment about periods.
| | DevRev.startRecording() | DevRevObservabilityExtKt.startRecording(DevRev.INSTANCE, context); | Starts the session recording. | | |
| | `DevRev.startRecording()` | `DevRevObservabilityExtKt.startRecording(DevRev.INSTANCE, context);` | Starts the session recording. | |
fern/docs/pages/plug-sdk/android.mdx
Outdated
| ##### Mask | ||
| ###### Using tag |
There was a problem hiding this comment.
This nesting is way too deep. Seems like it would be better to have the session analytics information on a separate page.
fern/docs/pages/plug-sdk/android.mdx
Outdated
| > [!NOTE] | ||
| > Use Tag method only when you don't have any other tag already applied to your UI element. |
There was a problem hiding this comment.
| > [!NOTE] | |
| > Use Tag method only when you don't have any other tag already applied to your UI element. | |
| <Note>Use the `Tag` method only when you don't have any other tag already applied to your UI element.</Note> |
fern/docs/pages/plug-sdk/android.mdx
Outdated
| ### Screen transition management | ||
|
|
||
| The DevRev SDK allows tracking of screen transitions to understand user navigation within your app. | ||
| You can check if a screen transition is in progress and manually update the state using the following methods: |
There was a problem hiding this comment.
| You can check if a screen transition is in progress and manually update the state using the following methods: | |
| You can check if a screen transition is in progress and manually update the state using the following methods. |
| @@ -635,11 +1072,11 @@ For example: | |||
|
|
|||
| ## Troubleshooting | |||
|
|
|||
| - **Issue**: Encountering problems with DevRev SDK integration. | |||
| - **Issue**: Encountering problems with DevRev SDK integration. | |||
There was a problem hiding this comment.
Should be more specific. What kind of "problems"? What does the developer or user see to indicate a problem?
| - **Issue**: Encountering problems with DevRev SDK integration. | |
| - **Issue**: Encountering problems with DevRev SDK integration. |
|
Published docs preview URL: https://devrev-preview-4291b4ed-c97e-4117-80df-d6620c6d0e1a.docs.buildwithfern.com |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| 2. Under **PLuG settings** copy the value under **Your unique App ID**. | ||
| 3. After obtaining the credentials, you can configure the DevRev SDK in your app. | ||
|
|
||
| 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. |
|
|
||
| ### Creating a new conversation | ||
|
|
||
| You have the ability to create a new conversation from within your app. The method will show the support chat screen and create a new conversation at the same time. |
There was a problem hiding this comment.
Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
| You have the ability to create a new conversation from within your app. The method will show the support chat screen and create a new conversation at the same time. | |
| You have the ability to create a new conversation from within your app. The method shows the support chat screen and creates a new conversation at the same time. |
|
Published docs preview URL: https://devrev-preview-b47bad86-0c41-4a86-8c11-2fa32b9578ca.docs.buildwithfern.com |
| </Tab> | ||
| </Tabs> | ||
|
|
||
| The user will be logged out by clearing their credentials, as well as unregistering the device from receiving push notifications, and stopping the session recording. |
There was a problem hiding this comment.
Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
| The user will be logged out by clearing their credentials, as well as unregistering the device from receiving push notifications, and stopping the session recording. | |
| The user is logged out by clearing their credentials, as well as unregistering the device from receiving push notifications, and stopping the session recording. |
| </Tab> | ||
| </Tabs> | ||
|
|
||
| Using this property will return the status of the session recording: |
There was a problem hiding this comment.
| DevRevObservabilityExtKt.endTimer(DevRev.INSTANCE, "response-time", new HashMap<String, String>().put("id", "task-1337")); | ||
| ``` | ||
| </Tab> | ||
| </Tabs> | ||
|
|
||
| ### Screen tracking | ||
|
|
||
| The DevRev SDK offers automatic screen tracking to help you understand how users navigate through your app. Although activities are automatically tracked, you can manually track screens or fragments using the following method: | ||
| 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: |
There was a problem hiding this comment.
Navigate is the correct verb here.
|
Published docs preview URL: https://devrev-preview-8242d77a-ff76-4ca3-87ef-7fa1a180271d.docs.buildwithfern.com |
| </Tab> | ||
| </Tabs> | ||
|
|
||
| If the user was disabled for session recording by using the stopAllMonitoring() method, you can use this method to enable recording at runtime. |
There was a problem hiding this comment.
🚫 [EkLine] reported by reviewdog 🐶
Don't use language (such as 'disabled ') that defines people by their disability. (EK00030)
| If the user was disabled for session recording by using the stopAllMonitoring() method, you can use this method to enable recording at runtime. | |
| If session recording was turned off for the user by using the stopAllMonitoring() method, you can use this method to enable recording at runtime. |
|
|
||
| <Callout intent="note"> | ||
| This feature only stores a monitoring permission flag and does not provide any user interface or dialog. | ||
| This feature will only store a monitoring permission flag, it will not provide any UI or dialog. |
There was a problem hiding this comment.
Suggestions:
- Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
| This feature will only store a monitoring permission flag, it will not provide any UI or dialog. | |
| This feature only stores a monitoring permission flag, it does not provide any UI or dialog. |
|
Published docs preview URL: https://devrev-preview-445382b8-fd23-4242-ae9d-c5d543b2a8b3.docs.buildwithfern.com |
| @@ -248,7 +355,7 @@ The DevRev SDK also provides a support button, which can be integrated into your | |||
| app:layout_constraintBottom_toBottomOf="parent" | |||
| app:layout_constraintEnd_toEndOf="parent" /> | |||
| ``` | |||
| The support button can be customized using default parameters, enabling you to tailor its appearance to your application's design. | |||
| The support button can also accept default parameters like | |||
|
|
|||
| ```kotlin | |||
| android:src="@your_drawable_here" | |||
There was a problem hiding this comment.
As they are separate properties, I'd leave them as is.
| > Use Tag method only when you don't have any other tag already applied to your UI element. | ||
| ### Mask | ||
| ### Using tag | ||
| <Note>Use the `Tag` method only when you don't have any other tag already applied to your UI element.</Note> |
There was a problem hiding this comment.
@zeeshan-devrev @rohan-devrev can we check if the method is actually uppercased?
| DevRevObservabilityExtKt.endTimer(DevRev.INSTANCE, "response-time", new HashMap<String, String>().put("id", "task-1337")); | ||
| ``` | ||
| </Tab> | ||
| </Tabs> | ||
|
|
||
| ### Screen tracking | ||
|
|
||
| The DevRev SDK offers automatic screen tracking to help you understand how users navigate through your app. Although activities are automatically tracked, you can manually track screens or fragments using the following method: | ||
| 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.
Navigate is the correct verb here.
|
@Yug2801 please either complete this PR or close it. |
|
Yes, I am closing this PR as all the comments here have been resolved in the ‘Modularize the Mobile SDK Documentation’ PR. |
This PR updates the Android SDK guide.