Skip to content

ISS-167739: Update Fern to support use default theme flag in documentation #218

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
May 7, 2025
Merged

ISS-167739: Update Fern to support use default theme flag in documentation #218

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d4a0406
Update the latest default theme feature iOS documentations
dhananjayj-dev May 6, 2025
d8140b9
Move this code snippet and description in support section from UIKit
dhananjayj-dev May 6, 2025
7fdca0e
Improve the documentation for dynamic theme configuration
dhananjayj-dev May 7, 2025
f629530
Make it sentence case for consistency
dhananjayj-dev May 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions fern/docs/pages/plug-sdk/ios/features.mdx
View file
Open in desktop
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [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/features.mdx

Line 10 in d4a0406

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [EkLine] reported by reviewdog 🐶

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

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

Line 263 in 7fdca0e

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:

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [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/features.mdx

Line 353 in 7fdca0e

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

Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,12 @@ await DevRev.updateUser(Identity(organizationID: "organization-1337"))

### UIKit

The DevRev SDK allows you to configure the theme dynamically based on the system appearance or use a default theme configured in the DevRev portal.

```swift
DevRev.prefersSystemTheme: Bool
```

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few things here:

  • We should be consistent with the spacing, there shouldn't be a new line after a section.
  • This property is meant to be used across all products, same as the in-app link handling. It's not specific to the support chat. Let's move it below the In-app link handling on the same level.
  • The wording should be:

    The DevRev SDK allows you to configure the theme dynamically based on the system appearance, or use the theme configured on the DevRev portal.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Yug2801 make sure you sync the changes with @dhananjayj-dev.

The support chat feature can be shown as a modal screen from a specific view controller or the top-most one, or can be pushed onto a navigation stack. 

To show the support chat screen in your app, you can use the following overloaded method:
Expand All @@ -92,6 +98,10 @@ await DevRev.showSupport(isAnimated:)
For example:

```swift
// When set to true (default), the DevRev UI will adapt theme dynamically to the system appearance.
// Set this flag to false to force the DevRev UI to use the default theme configured in the DevRev portal.
DevRev.prefersSystemTheme: Bool

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No need for this example. The property itself is self-explaining.

// Push the support chat screen to a navigation stack.
await DevRev.showSupport(from: mainNavigationController)

Expand Down