-
Notifications
You must be signed in to change notification settings - Fork 3
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.
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
ISS-167739: Update Fern to support use default theme flag in documentation #218
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 support@ekline.io. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, let's update the PR title and description to use the proper terminology, the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I missed something in the original review.
|
||
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 | ||
``` | ||
|
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
// 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 | ||
|
There was a problem hiding this comment.
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.
@@ -157,6 +157,14 @@ You can further customize the behavior by setting the `shouldDismissModalsOnOpen | |||
DevRev.shouldDismissModalsOnOpenLink: Bool | |||
``` | |||
|
|||
## 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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: |
There was a problem hiding this comment.
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)
To properly handle push notifications, implement the following method, typically in either the `UNUserNotificationCenterDelegate.userNotificationCenter(_:didReceive:)` or `UIApplicationDelegate.application(_:didReceiveRemoteNotification:fetchCompletionHandler:)`: |
209e865
into
feature/ISS-158592-unify-moble-sdk-guide
* Add flutter documentation * Add flutter documentation * Add a missing In app link handling section * Add react native expo documetation * Add a new platforms in the SDK index * Split iOS documentations in sub pages * Add the migration guide * Split the android documentation sections * Split the cordova documentation sections * Split the React Native documentation sections * Add migration guide for flutter * Add links to new platforms SDK integration docs * Split the Flutter documentation sections * Split the React Native Expo documentation sections * Use the better icons new platforms * Move under right namespaces and update linkings * ISS-167739: Update Fern to support use default theme flag in documentation (#218) * Update the latest default theme feature iOS documentations * Move this code snippet and description in support section from UIKit * Improve the documentation for dynamic theme configuration * Make it sentence case for consistency * Remove flutter documentation * Add sample app section * Update the android documentations with the latest read me guides * Update documentation with the latest read me guide of iOS * Remove the linking of flutter documentation * Change the header casing to sentence case * Update the platforms and fix the indentations * Move web SDK under the web namespace * Move web SDK under the web namespace * Move all mobile SDKs under the mobile namespace * Update the paths * Move all mobile SDKs under the mobile namespace * Fix the typos * Update to the correct icon * Add the missing slugs for and its contents for new pages * Update the links for redirections to the pages * Add the missing screenshot * Update the path * Fix the navigations * Fix the typo * Fix the filename in path * Fix the typos * Fix the navigations * Remove unneeded pages * Keep features page and remove the other file * Fix the navigation for push notification page * Add sample app section in quick start guide for Android * Improve description in sample app section and add links for public repositories * Fix the description in sample app section * Improve the description in sample app section * Add a separate quick start guide for Expo * Fix the duplicate slug * Improve the menu names for React native and Expo quickstart guide * consistent PLuG Web SDK usage * Update fern/docs/pages/sdks/mobile/react-native/quickstart-expo.mdx Co-authored-by: Ben Colborn <ben.colborn@devrev.ai> * Update fern/docs/pages/sdks/mobile/react-native/quickstart-expo.mdx Co-authored-by: Ben Colborn <ben.colborn@devrev.ai> * Update the setup section to make it consistent with other platforms * Update Android documentation to choose DevRev theme or system theme preference * Update React Native documentation to choose DevRev or system preferred theme * Fix the method signature * Update the feature to only iOS for now * Remove prefers theme feature from Android temporarily --------- Co-authored-by: Ben Colborn <ben.colborn@devrev.ai> Co-authored-by: Bojan Dimovski <hello@bojandimovski.com>
This PR updates the Fern documentation to include details about the useDefaultTheme flag. The new section demonstrates how to enable this flag to ensure the support feature always uses the default theme, regardless of the user’s system theme setting. This enhancement helps developers maintain consistent UI behavior across environments.