Skip to content
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

Mobile-sdk.mdx #108

Merged
merged 81 commits into from
Dec 4, 2024
Merged

Mobile-sdk.mdx #108

merged 81 commits into from
Dec 4, 2024

Conversation

@Atul-Butola Atul-Butola requested a review from a team as a code owner November 4, 2024 06:53
@Atul-Butola Atul-Butola changed the title **WIP**-Create sdk-android.mdx **WIP** Mobile-sdk.mdx Nov 4, 2024
Copy link
Contributor

github-actions bot commented Nov 4, 2024

Copy link
Contributor

github-actions bot commented Nov 4, 2024

Copy link
Contributor

github-actions bot commented Nov 4, 2024

Copy link
Contributor

github-actions bot commented Nov 4, 2024

Copy link
Contributor

github-actions bot commented Nov 4, 2024

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

github-actions bot commented Nov 6, 2024

Copy link
Contributor

github-actions bot commented Nov 6, 2024

Copy link
Contributor

github-actions bot commented Nov 6, 2024

Copy link
Contributor

github-actions bot commented Nov 6, 2024

Copy link
Contributor

github-actions bot commented Nov 6, 2024

Copy link
Contributor

github-actions bot commented Nov 6, 2024

Copy link
Contributor

github-actions bot commented Nov 6, 2024

Copy link
Contributor

github-actions bot commented Nov 6, 2024

@Atul-Butola Atul-Butola requested a review from bojan November 19, 2024 06:01
Copy link
Contributor

Copy link
Contributor

@bojan bojan left a comment

Choose a reason for hiding this comment

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

A few minor things.

fern/docs/pages/plug-sdk/push-notification.mdx Outdated Show resolved Hide resolved
fern/docs/pages/plug-sdk/sdk-ios.mdx Show resolved Hide resolved
fern/docs/pages/plug-sdk/sdk-android.mdx Show resolved Hide resolved
Copy link
Contributor

@bojan bojan left a comment

Choose a reason for hiding this comment

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

The copies are ready.

fern/docs/pages/plug-sdk/push-notification.mdx Outdated Show resolved Hide resolved
Copy link
Contributor

Copy link
Contributor

Copy link
Contributor

Copy link
Contributor

Copy link
Contributor

@bojan bojan left a comment

Choose a reason for hiding this comment

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

Good to go!

@bc-devrev bc-devrev added No EkLine Skip EkLine automated QA and removed No EkLine Skip EkLine automated QA labels Dec 2, 2024
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

EkLine

📝 [EkLine] reported by reviewdog 🐶

Avoid using 'we' as it can come off as patronizing. For example, write 'The configuration is complete' rather than 'We are now done with the configuration.' (EK81039)

We recommend integrating the DevRev SDK using SPM.


🚫 [EkLine] reported by reviewdog 🐶

'Swift Package Manager' should use sentence-style capitalization. (EK00037)

### Swift Package Manager


⚠️ [EkLine] reported by reviewdog 🐶

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

1. Open your project in Xcode and navigate to the **Add Package Dependency**.


🚫 [EkLine] reported by reviewdog 🐶

Must put the ending punctuation at the end of a list item. (EK00041)

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


🚫 [EkLine] reported by reviewdog 🐶

Must put the ending punctuation at the end of a list item. (EK00041)

1. Add the following to your Podfile:


📝 [EkLine] reported by reviewdog 🐶

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

This will install the DevRev SDK in your project, making it ready for use.


📝 [EkLine] reported by reviewdog 🐶

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.


🚫 [EkLine] reported by reviewdog 🐶

Must put the ending punctuation at the end of a list item. (EK00041)


🚫 [EkLine] reported by reviewdog 🐶

Must put the ending punctuation at the end of a list item. (EK00041)


📝 [EkLine] reported by reviewdog 🐶

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

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.


⚠️ [EkLine] reported by reviewdog 🐶

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:


📝 [EkLine] reported by reviewdog 🐶

Consider removing 'properly '. (EK00006)

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


🚫 [EkLine] reported by reviewdog 🐶

Must put the ending punctuation at the end of a list item. (EK00041)

1. Add your credentials:


🚫 [EkLine] reported by reviewdog 🐶

Must put the ending punctuation at the end of a list item. (EK00041)

3. Configure code signing for the sample target:


📝 [EkLine] reported by reviewdog 🐶

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

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

If you are configuring an iOS app, proceed to step 2. For an Android app, skip to step 3.
</Callout>

2. iOS app configuration
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 🐶

Must put the ending punctuation at the end of a list item. (EK00041)

Suggested change
2. iOS app configuration
2. iOS app configuration.


b. Click **Save App** to complete the iOS setup.

3. Android app configuration
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 🐶

Must put the ending punctuation at the end of a list item. (EK00041)

Suggested change
3. Android app configuration
3. Android app configuration.

</Tabs>

4. In the `onCreate` method of your `Application`, configure the DevRev SDK with the required parameters using the credentials obtained earlier.
5. Ensure that the custom application is specified in the `AndroidManifest.xml`, as shown below:
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 🐶

Must put the ending punctuation at the end of a list item. (EK00041)

Suggested change
5. Ensure that the custom application is specified in the `AndroidManifest.xml`, as shown below:
5. Ensure that the custom application is specified in the `AndroidManifest.xml`, as shown below.

</Tab>
<Tab title="Java">
```java
DevRev.INSTANCE.identifyAnonymousUser(
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 🐶

Keep one space between words in 'v.I'. (EK00025)

Suggested change
DevRev.INSTANCE.identifyAnonymousUser(
DevRev. INSTANCE. identifyAnonymousUser(

</Tab>
<Tab title="Java">
```java
DevRev.INSTANCE.identifyUnverifiedUser(
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 🐶

Keep one space between words in 'v.I'. (EK00025)

Suggested change
DevRev.INSTANCE.identifyUnverifiedUser(
DevRev. INSTANCE.identifyUnverifiedUser(


4. To extract a specific piece of data from the payload, use the key to access the value in the data map.

5. To retrieve the "message" from the payload:
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 🐶

Must put the ending punctuation at the end of a list item. (EK00041)

Suggested change
5. To retrieve the "message" from the payload:
5. To retrieve the "message" from the payload:

<Tab title="Kotlin">
```kotlin
class MyFirebaseMessagingService: FirebaseMessagingService {
// ...
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 🐶

In general, don't use an ellipsis. (EK00011)

Suggested change
// ...


## Requirements

- Xcode 16.0 or higher (latest stable version available on the App Store)
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 🐶

Must put the ending punctuation at the end of a list item. (EK00041)

Suggested change
- Xcode 16.0 or higher (latest stable version available on the App Store)
- Xcode 16.0 or higher (latest stable version available on the App Store).

## Requirements

- Xcode 16.0 or higher (latest stable version available on the App Store)
- Swift 5.9 or later
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 🐶

Must put the ending punctuation at the end of a list item. (EK00041)

Suggested change
- Swift 5.9 or later
- Swift 5.9 or later.


- 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 13
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 🐶

Must put the ending punctuation at the end of a list item. (EK00041)

Suggested change
- Set the minimum deployment target for your iOS application as iOS 13
- Set the minimum deployment target for your iOS application as iOS 13.

Copy link
Contributor

@bc-devrev bc-devrev left a comment

Choose a reason for hiding this comment

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

Really needs some polish but let's get it out with the few small changes I've indicated.

fern/versions/public.yml Outdated Show resolved Hide resolved
fern/versions/public.yml Outdated Show resolved Hide resolved
fern/versions/public.yml Outdated Show resolved Hide resolved
@bc-devrev
Copy link
Contributor

Really needs some polish but let's get it out with the few small changes I've indicated.

And the suggestions from EkLine where appropriate.

@bojan
Copy link
Contributor

bojan commented Dec 2, 2024

Really needs some polish but let's get it out with the few small changes I've indicated.

And the suggestions from EkLine where appropriate.

I noticed that most of the EkLine suggestions in the code blocks are breaking changes. I wouldn't change the code blocks since they might become incompilable.

Copy link
Contributor

github-actions bot commented Dec 4, 2024

Copy link
Contributor

github-actions bot commented Dec 4, 2024

Copy link
Contributor

github-actions bot commented Dec 4, 2024

Copy link
Contributor

github-actions bot commented Dec 4, 2024

@Atul-Butola Atul-Butola merged commit 26c8d6c into main Dec 4, 2024
2 checks passed
@Atul-Butola Atul-Butola deleted the Mobile-SDKs branch December 4, 2024 11:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
No EkLine Skip EkLine automated QA
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants