Mobile-sdk.mdx #108

+The DevRev SDK can be integrated using either Swift Package Manager (SPM) or CocoaPods.
+
+<Callout intent="note">
+We recommend integrating the DevRev SDK using Swift Package Manager.
+</Callout>
+
+### Swift Package Manager (Recommended)
+
+To integrate the DevRev SDK into your project using Swift Package Manager (SPM):


Since the abbreviation for Swift Package Manager is a term of art and is well known within the community, we can refer to it using SPM after the first mention. I'll make sure to update the iOS readme as well.

Suggested change

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

<Callout intent="note">

We recommend integrating the DevRev SDK using Swift Package Manager.

</Callout>

### Swift Package Manager (Recommended)

To integrate the DevRev SDK into your project using Swift Package Manager (SPM):

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

<Callout intent="note">

We recommend integrating the DevRev SDK using Swift Package Manager.

</Callout>

### Swift Package Manager

To integrate the DevRev SDK into your project using SPM:

bojan · 2024-11-07T14:55:00Z

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

+1. Open your project in Xcode and navigate to the **Add Package Dependency**.
+2. Enter the DevRev SDK URL under **Enter Package URL**:
+- For HTTPS: https://github.com/devrev/devrev-sdk-ios
+- For SSH: [email protected]:devrev/devrev-sdk-ios.git **RECONFIRM THIS**


Suggested change

- For SSH: [email protected]:devrev/devrev-sdk-ios.git **RECONFIRM THIS**

- For SSH: `[email protected]:devrev/devrev-sdk-ios.git`

bojan · 2024-11-07T14:58:32Z

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

+```ruby
+
+pod 'DevRevSDK', '~> 1.0.0'
+
+```


Since this is a codeblock, adding a GH suggestion here won't work, so let's just remove the blank lines:

pod 'DevRevSDK', '~> 1.0.0'

bojan · 2024-11-07T15:04:56Z

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

+1. Open the DevRev web app at [https://app.devrev.ai](https://app.devrev.ai) and go to the **Settings** page.
+2. Under **PLuG settings** obtain **Your unique App ID** (referred to as `supportID` in the code).
+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.


This section has breaking changes, let's try to follow the original as close as possible.

Feel free to adapt the wording a bit.

Suggested change

1. Open the DevRev web app at [https://app.devrev.ai](https://app.devrev.ai) and go to the **Settings** page.

2. Under **PLuG settings** obtain **Your unique App ID** (referred to as `supportID` in the code).

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.

1. Open the DevRev web app at [https://app.devrev.ai](https://app.devrev.ai) and go to the **Settings** page.

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.

<Callout intent="critical">

The DevRev SDK must be configured before you can use any of its features.

</Callout>

bojan · 2024-11-07T15:25:15Z

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

+await DevRev.trackEvent(name: "open-message-screen", properties: ["id": "foo-bar-1337"])
+```
+
+## Session analytics


This is a good pointer, we'll change the mentions of Observability with Session analytics in the SDKs as well.

cc @rohan-devrev

bojan · 2024-11-07T16:00:55Z

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

+
+### 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 using the following method:


We need to tweak this a bit since iOS doesn't have activities:

Suggested change

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 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:

bojan · 2024-11-07T16:01:49Z

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

+
+### Configuration
+
+To receive push notifications, you need to configure your DevRev organization by following the Push Notifications Integration guide (**TBD ITEM**).


We need Ribhu's input here for the TBD ITEM.

bojan · 2024-11-07T16:03:31Z

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

+
+To receive push notifications, you need to configure your DevRev organization by following the Push Notifications Integration guide (**TBD ITEM**).
+
+You need to ensure that your iOS app is configured to receive push notifications. You can follow the [Apple documentation](https://developer.apple.com/documentation/usernotifications/registering_your_app_with_apns) for guidance on registering your app with Apple Push Notification Service (APNS).


Apple naming, don't ask 🤣

Suggested change

You need to ensure that your iOS app is configured to receive push notifications. You can follow the [Apple documentation](https://developer.apple.com/documentation/usernotifications/registering_your_app_with_apns) for guidance on registering your app with Apple Push Notification Service (APNS).

You need to ensure that your iOS app is configured to receive push notifications. You can follow the [Apple documentation](https://developer.apple.com/documentation/usernotifications/registering_your_app_with_apns) for guidance on registering your app with Apple Push Notification Service (APNs).

bojan · 2024-11-07T16:06:15Z

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

+DevRev.registerDeviceToken(_:deviceID:)
+```
+
+The method requires a device identifier, which can either be an identifier unique to your system or the Apple-provided Vendor Identifier (IDFV). Typically, registration is called from the `AppDelegate.application(_:didRegisterForRemoteNotificationsWithDeviceToken:)` method.


Suggested change

The method requires a device identifier, which can either be an identifier unique to your system or the Apple-provided Vendor Identifier (IDFV). Typically, registration is called from the `AppDelegate.application(_:didRegisterForRemoteNotificationsWithDeviceToken:)` method.

The method requires a device identifier, which can either be an identifier unique to your system or the Apple-provided Vendor Identifier (IDFV). Typically, the token registration is called from the `AppDelegate.application(_:didRegisterForRemoteNotificationsWithDeviceToken:)` method.

bc-devrev

Indent code samples and sub-lists under list items.
Consolidate tab groups; don't follow a tab group for different languages with another tab group for the same languages.
Minimize the use of tables since Turing can't interpret them.
Address comments from EkLine; in particular never use "foo".

bc-devrev · 2024-11-06T16:55:56Z

fern/versions/public.yml

@@ -80,6 +80,9 @@ navigation:
          - page: Integrate PLuG with your iOS app
            slug: install-ios
            path: ../docs/pages/plug-sdk/install-ios.mdx
+          - page: Integrate PLuG SDKs with your Android app
+            slug: sdk-android


Should have some convention for the slugs and paths. Like just the platform (ios, android, web) if that's sufficient, or the platform plus a keyword for the goal (install, integrate, etc.).

bc-devrev · 2024-11-07T17:25:50Z

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

+
+```xml
+<application
+    android:name=".FooApplication">


Never use "foo". https://www.notion.so/devrev/What-words-or-phrases-should-be-avoided-and-why-c424af306b2f42c3b2db511e8e7dd459?pvs=4

Suggested change

android:name=".FooApplication">

android:name=".ExampleApplication">

bc-devrev · 2024-11-07T17:27:47Z

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

+  <Tab title="Kotlin">
+```kotlin
+// Identify an anonymous user without a user identifier.
+DevRev.identifyAnonymousUser("abcd1234")


Are these "examples" really necessary? They don't seem to add much over the reference.

bc-devrev · 2024-11-07T17:29:38Z

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

+
+1. Add the following dependencies to your app's `build.gradle.kts` file to get the latest version of our SDK:
+
+```kotlin


Throughout, indent code samples under the numbered item.

Suggested change

```kotlin

```kotlin

bc-devrev · 2024-11-07T17:30:58Z

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

+If you don’t have a custom `Application` class, create one as shown below.
+</Callout>
+
+<Tabs>


Over all there are about twice as many tab groups as necessary. Combine the code samples into the same tab as the relevant language.

bc-devrev · 2024-11-07T17:34:44Z

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

+
+Here are the available methods to help you control the session recording feature:
+
+| Kotlin                   | Java                                                               | Action                                                    |


bc-devrev · 2024-11-07T17:36:30Z

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

+Before using the sample app, configure it with your Apple Developer team and DevRev credentials. For convenience, the code is marked with compiler error directives (`#error`) in areas that require your attention.
+
+1. Add your credentials:
+- For SwiftUI, add your credentials to `ContentView.swift`.


Indent

Suggested change

- For SwiftUI, add your credentials to `ContentView.swift`.

- For SwiftUI, add your credentials to `ContentView.swift`.

Create sdk-android.mdx

7bd1b4b

ISS-124016

Atul-Butola requested a review from a team as a code owner November 4, 2024 06:53

Atul-Butola changed the title **WIP**-Create sdk-android.mdx **WIP** Mobile-sdk.mdx Nov 4, 2024

Update sdk-android.mdx

25b1ced

Update sdk-android.mdx

c581939

Update public.yml

1287f4f

Update sdk-android.mdx

621dc86

Atul-Butola marked this pull request as draft November 6, 2024 06:55

Update sdk-android.mdx

04d2538

Update sdk-android.mdx

0846663

Update sdk-android.mdx

7036a55

Update sdk-android.mdx

9491fb2

Update sdk-android.mdx

78649c5

Update sdk-android.mdx

9aa36c5

Update sdk-android.mdx

f7a5ca8

Update sdk-android.mdx

977aa06

Create sdk-ios.mdx

a57f9d7

Atul-Butola added 2 commits November 7, 2024 10:55

Update sdk-ios.mdx

367fcc4

Update sdk-ios.mdx

7241af5

Atul-Butola added 2 commits November 7, 2024 12:49

Update public.yml

1cf4dce

Update public.yml

c7445c7

Atul-Butola added 3 commits November 7, 2024 13:03

Update public.yml

7bfaa48

Update sdk-ios.mdx

037c77a

Update sdk-ios.mdx

5213623

Update sdk-ios.mdx

9707a58

Update sdk-android.mdx

cc8bbf2

Update sdk-android.mdx

708bac6

Update sdk-ios.mdx

f2dffec

Atul-Butola changed the title **WIP** Mobile-sdk.mdx Mobile-sdk.mdx Nov 7, 2024

Atul-Butola marked this pull request as ready for review November 7, 2024 11:28

Atul-Butola requested review from bc-devrev, bojan and rohan-devrev November 7, 2024 11:51

Atul-Butola added 2 commits November 7, 2024 17:31

Update sdk-ios.mdx

d184b66

Update sdk-android.mdx

81dd110

bojan requested changes Nov 7, 2024

View reviewed changes

bc-devrev added the EkLine Run EkLine automated QA label Nov 7, 2024

bc-devrev requested changes Nov 7, 2024

View reviewed changes

	- For SSH: [email protected]:devrev/devrev-sdk-ios.git RECONFIRM THIS
	- For SSH: `[email protected]:devrev/devrev-sdk-ios.git`


		### 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 using the following method:


		### Configuration

		To receive push notifications, you need to configure your DevRev organization by following the Push Notifications Integration guide (TBD ITEM).


		To receive push notifications, you need to configure your DevRev organization by following the Push Notifications Integration guide (TBD ITEM).

		You need to ensure that your iOS app is configured to receive push notifications. You can follow the [Apple documentation](https://developer.apple.com/documentation/usernotifications/registering_your_app_with_apns) for guidance on registering your app with Apple Push Notification Service (APNS).

	The method requires a device identifier, which can either be an identifier unique to your system or the Apple-provided Vendor Identifier (IDFV). Typically, registration is called from the `AppDelegate.application(_:didRegisterForRemoteNotificationsWithDeviceToken:)` method.
	The method requires a device identifier, which can either be an identifier unique to your system or the Apple-provided Vendor Identifier (IDFV). Typically, the token registration is called from the `AppDelegate.application(_:didRegisterForRemoteNotificationsWithDeviceToken:)` method.

	android:name=".FooApplication">
	android:name=".ExampleApplication">


		1. Add the following dependencies to your app's `build.gradle.kts` file to get the latest version of our SDK:

		```kotlin


		Here are the available methods to help you control the session recording feature:

		\| Kotlin \| Java \| Action \|

	\| Kotlin \| Java \| Action \|
	\| Action \| Kotlin (`DevRev`) \| Java (`DevRevObservabilityExtKt`) \|

	- For SwiftUI, add your credentials to `ContentView.swift`.
	- For SwiftUI, add your credentials to `ContentView.swift`.

Mobile-sdk.mdx #108

Are you sure you want to change the base?

Mobile-sdk.mdx #108

Conversation

Atul-Butola commented Nov 4, 2024 • edited Loading

github-actions bot commented Nov 4, 2024

github-actions bot commented Nov 4, 2024

github-actions bot commented Nov 4, 2024

github-actions bot commented Nov 4, 2024

github-actions bot commented Nov 4, 2024

github-actions bot commented Nov 6, 2024

github-actions bot commented Nov 6, 2024

github-actions bot commented Nov 6, 2024

github-actions bot commented Nov 6, 2024

github-actions bot commented Nov 6, 2024

github-actions bot commented Nov 6, 2024

github-actions bot commented Nov 6, 2024

github-actions bot commented Nov 6, 2024

github-actions bot commented Nov 7, 2024

github-actions bot commented Nov 7, 2024

github-actions bot commented Nov 7, 2024

github-actions bot commented Nov 7, 2024

github-actions bot commented Nov 7, 2024

github-actions bot commented Nov 7, 2024

github-actions bot commented Nov 7, 2024

github-actions bot commented Nov 7, 2024

github-actions bot commented Nov 7, 2024

bojan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bojan Nov 7, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bc-devrev left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Atul-Butola commented Nov 4, 2024 •

edited

Loading

bojan Nov 7, 2024 •

edited

Loading