ISS-160256: Restructure the SDK documentation for iOS #215

Yug2801 · 2025-04-25T06:59:21Z

This PR restructures the iOS SDK documentation.

github-actions · 2025-04-25T07:00:14Z

🌟 EkLine Reviewer

Hello! 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 · 2025-04-25T07:00:41Z

Published docs preview URL: https://devrev-preview-a96ff0da-5ffb-4bad-8c04-17358ce58a82.docs.buildwithfern.com

bc-devrev

I think the content in this page is too much for one page. The structure starts to break down pretty early. Is it possible to move some of it to another page?

You could also try the stylecheck utility which is experimental.

bc-devrev · 2025-04-25T17:42:31Z

fern/docs/pages/plug-sdk/ios.mdx

 	**Solution**: Ensure you have correctly called one of the identification methods: `DevRev.identifyUnverifiedUser(...)` or `DevRev.identifyAnonymousUser(...)`.

- **Issue**: Not receiving push notifications.   
+- **Issue**: Not receiving push notifications.


Suggested change

- **Issue**: Not receiving push notifications.

- **Issue**: Users do not receive push notifications.

bc-devrev · 2025-04-25T17:45:48Z

fern/docs/pages/plug-sdk/ios.mdx

@@ -1,12 +1,13 @@
 This section describes the process of integrating the DevRev SDK with your iOS app.

-## Requirements
+## Quickstart


I recommend against this. It doesn't look all that "quick" to me. "Integration" seems like a more suitable term, but that's used in the section that has SPM and CocoaPods.

We'll split it in the next iteration into sub-pages.

bc-devrev · 2025-04-25T17:50:18Z

fern/docs/pages/plug-sdk/ios.mdx


 - Xcode 16.0 or higher (latest stable version available on the App Store).
 - Swift 5.9 or later.
 - Set the minimum deployment target for your iOS application as iOS 15.

-## Integration
+### Integration

 The DevRev SDK can be integrated using either Swift Package Manager (SPM) or CocoaPods.


The SPM and CocoaPods sections aren't nested properly. They'd need to be H4, which isn't recommended. An accordion group or tabs might be a better option for those sections.

bc-devrev · 2025-04-25T17:51:16Z

fern/docs/pages/plug-sdk/ios.mdx

@@ -175,6 +202,13 @@ To display the support chat screen in a SwiftUI app, you can use the following v
 DevRev.supportView
 ```

+#### Creating a new conversation


Shouldn't have H4.

bc-devrev · 2025-04-25T17:52:40Z

fern/docs/pages/plug-sdk/ios.mdx

 - UIKit apps

 Configure the SDK in the `AppDelegate.application(_:didFinishLaunchingWithOptions:)` method.

 - SwiftUI apps

 Depending on your app's architecture, configure the SDK at the app's entry point or initial view.
-
-## Identification
+## Features


I'm not sure of the purpose of calling a list of stuff "Features". I'm also not sure if everything in this group is really a feature.

Suggested change

## Features

## Features

These are all features of the SDK and they will get split into sub-pages in the next iteration.

bc-devrev · 2025-04-25T17:57:19Z

fern/docs/pages/plug-sdk/ios.mdx

 	**Solution**: Double-check the setup process and ensure that `DevRevSDK` is correctly linked to your application.

- **Issue**: How does the DevRev SDK handle errors?   
+- **Issue**: How does the DevRev SDK handle errors?


This is important information to include but doesn't belong here. I'd suggest moving it up to the "Quickstart" section.

The troubleshooting will go into a sub-page in the next iteration.

github-actions · 2025-04-29T07:03:57Z

Published docs preview URL: https://devrev-preview-47b977fb-3eb1-4d47-bca1-13d1cfc957d1.docs.buildwithfern.com

bojan · 2025-05-06T11:09:04Z

fern/docs/pages/plug-sdk/ios.mdx

@@ -1,12 +1,13 @@
 This section describes the process of integrating the DevRev SDK with your iOS app.

-## Requirements
+## Quickstart


We'll split it in the next iteration into sub-pages.

bojan · 2025-05-06T11:10:24Z

fern/docs/pages/plug-sdk/ios.mdx

-	pod 'DevRevSDK', '~> 1.0.0'
-	```
-2. Run `pod install` in your project directory.
+  </Tab>


Let's not leave blank lines before the closing tab (for both cases).

bojan · 2025-05-06T11:11:21Z

fern/docs/pages/plug-sdk/ios.mdx

 - UIKit apps

 Configure the SDK in the `AppDelegate.application(_:didFinishLaunchingWithOptions:)` method.

 - SwiftUI apps

 Depending on your app's architecture, configure the SDK at the app's entry point or initial view.
-
-## Identification
+## Features


These are all features of the SDK and they will get split into sub-pages in the next iteration.

bojan · 2025-05-06T11:11:55Z

fern/docs/pages/plug-sdk/ios.mdx

 	**Solution**: Double-check the setup process and ensure that `DevRevSDK` is correctly linked to your application.

- **Issue**: How does the DevRev SDK handle errors?   
+- **Issue**: How does the DevRev SDK handle errors?


The troubleshooting will go into a sub-page in the next iteration.

github-actions · 2025-05-06T16:03:01Z

fern/docs/pages/plug-sdk/ios.mdx

+DevRev.logout(deviceID:)
+```
+
+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.


⚠️ [EkLine] _{reported by reviewdog 🐶}

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

Suggested change

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.

github-actions · 2025-05-06T16:03:02Z

fern/docs/pages/plug-sdk/ios.mdx

@@ -175,7 +203,14 @@ To display the support chat screen in a SwiftUI app, you can use the following v
 DevRev.supportView
 ```

-#### New conversation closure
+### 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.


⚠️ [EkLine] _{reported by reviewdog 🐶}

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

Suggested change

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.

github-actions · 2025-05-06T16:03:03Z

fern/docs/pages/plug-sdk/ios.mdx

⚠️ [EkLine] _{reported by reviewdog 🐶}

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

fern-api-docs/fern/docs/pages/plug-sdk/ios.mdx

Line 53 in ec2c085

The SDK will be ready for use once you execute the following configuration method.

github-actions · 2025-05-06T16:03:04Z

fern/docs/pages/plug-sdk/ios.mdx

⚠️ [EkLine] _{reported by reviewdog 🐶}

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

fern-api-docs/fern/docs/pages/plug-sdk/ios.mdx

Line 83 in ec2c085

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.

github-actions · 2025-05-06T16:03:09Z

Published docs preview URL: https://devrev-preview-863ec4b6-69bd-4300-9c82-fe8e999e063f.docs.buildwithfern.com

github-actions · 2025-05-07T10:01:30Z

fern/docs/pages/plug-sdk/ios.mdx

+DevRev.shouldDismissModalsOnOpenLink: Bool
+```
+
+### Dynamic Theme Configuration


🚫 [EkLine] _{reported by reviewdog 🐶}

'Dynamic Theme Configuration' should use sentence-style capitalization. (EK00037)

github-actions · 2025-05-07T10:01:30Z

fern/docs/pages/plug-sdk/ios.mdx

+
+### Dynamic Theme Configuration
+
+The DevRev SDK allows you to configure the theme dynamically based on the system appearance, or use the theme configured on the DevRev portal. By default, the theme will be dynamic and follow the system appearance.


⚠️ [EkLine] _{reported by reviewdog 🐶}

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

Suggested change

The DevRev SDK allows you to configure the theme dynamically based on the system appearance, or use the theme configured on the DevRev portal. By default, the theme will be dynamic and follow the system appearance.

The DevRev SDK allows you to configure the theme dynamically based on the system appearance, or use the theme configured on the DevRev portal. By default, the theme is dynamic and follows the system appearance.

github-actions · 2025-05-07T10:01:31Z

fern/docs/pages/plug-sdk/ios.mdx

@@ -241,6 +305,17 @@ The session recording feature includes the following methods to control the reco
 |`DevRev.stopRecording()`    | Ends the session recording and uploads it to the portal. |
 |`DevRev.pauseRecording()`   | Pauses the ongoing session recording.                     |
 |`DevRev.resumeRecording()`  | Resumes a paused session recording.                       |
+|`DevRev.processAllOnDemandSessions()`| Stops the ongoing user recording and sends all on-demand sessions along with the current recording. |
+
+Using this property will return the status of the session recording:


⚠️ [EkLine] _{reported by reviewdog 🐶}

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

Suggested change

Using this property will return the status of the session recording:

Using this property returns the status of the session recording.

github-actions · 2025-05-07T10:01:31Z

fern/docs/pages/plug-sdk/ios.mdx

 	**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.   
+- **Issue**: Support chat won't show.


⚠️ [EkLine] _{reported by reviewdog 🐶}

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

Suggested change

- **Issue**: Support chat won't show.

- **Issue**: Support chat doesn't show.

github-actions · 2025-05-07T10:01:32Z

fern/docs/pages/plug-sdk/ios.mdx

⚠️ [EkLine] _{reported by reviewdog 🐶}

Consider using 'go' instead of 'navigate'. (EK25033)

fern-api-docs/fern/docs/pages/plug-sdk/ios.mdx

Line 380 in 5c69e62

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:

github-actions · 2025-05-07T10:01:33Z

fern/docs/pages/plug-sdk/ios.mdx

📝 [EkLine] _{reported by reviewdog 🐶}

Remove 'properly ' if it's not important to the meaning of the statement. (EK00006)

fern-api-docs/fern/docs/pages/plug-sdk/ios.mdx

Line 470 in 5c69e62

To properly handle push notifications, implement the following method, typically in either the `UNUserNotificationCenterDelegate.userNotificationCenter(_:didReceive:)` or `UIApplicationDelegate.application(_:didReceiveRemoteNotification:fetchCompletionHandler:)`:

github-actions · 2025-05-07T10:01:41Z

Published docs preview URL: https://devrev-preview-6b1eb12a-b4b2-4303-80d8-2b50f0b61e75.docs.buildwithfern.com

Improve section titles and structure

2d329f4

Yug2801 requested review from bojan, bc-devrev and dhananjayj-dev April 25, 2025 06:59

Yug2801 self-assigned this Apr 25, 2025

Yug2801 requested a review from a team as a code owner April 25, 2025 06:59

bc-devrev requested changes Apr 25, 2025

View reviewed changes

bc-devrev reviewed Apr 25, 2025

View reviewed changes

Yug2801 added 3 commits April 29, 2025 12:28

Improve section in tabs

1609b3b

Improve h4 to h3

2a5cf9e

Improve troubleshooting

ff023d6

bojan requested changes May 6, 2025

View reviewed changes

Improve spacing

ec2c085

github-actions bot reviewed May 6, 2025

View reviewed changes

Improve the documentation for dynamic theme configuration

5c69e62

github-actions bot reviewed May 7, 2025

View reviewed changes

Yug2801 closed this Jun 4, 2025

	- Issue: Not receiving push notifications.
	- Issue: Users do not receive push notifications.

	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.

	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.


		### Dynamic Theme Configuration

		The DevRev SDK allows you to configure the theme dynamically based on the system appearance, or use the theme configured on the DevRev portal. By default, the theme will be dynamic and follow the system appearance.

	Using this property will return the status of the session recording:
	Using this property returns the status of the session recording.

	- Issue: Support chat won't show.
	- Issue: Support chat doesn't show.

ISS-160256: Restructure the SDK documentation for iOS #215

ISS-160256: Restructure the SDK documentation for iOS #215

Uh oh!

Conversation

Yug2801 commented Apr 25, 2025

Uh oh!

github-actions bot commented Apr 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🌟 EkLine Reviewer

Uh oh!

github-actions bot commented Apr 25, 2025

Uh oh!

bc-devrev left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bc-devrev Apr 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bc-devrev Apr 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Apr 29, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot May 6, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot May 6, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot May 6, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot May 6, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented May 6, 2025

Uh oh!

github-actions bot May 7, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot May 7, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot May 7, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot May 7, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot May 7, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot May 7, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Apr 25, 2025 •

edited

Loading

bc-devrev left a comment •

edited

Loading

bc-devrev Apr 25, 2025 •

edited

Loading

bc-devrev Apr 25, 2025 •

edited

Loading