Skip to content

Commit d753415

Browse files
buenaflorlizokm
andauthored
Apply suggestions from code review
Co-authored-by: Liza Mock <[email protected]>
1 parent 1782293 commit d753415

File tree

6 files changed

+19
-20
lines changed

6 files changed

+19
-20
lines changed

docs/platforms/kotlin-multiplatform/configuration/gradle.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
22
title: Gradle Plugin
33
sidebar_order: 5
4-
description: "Learn more about the Sentry's Kotlin Multiplatform Gradle Plugin."
4+
description: "Learn how to set up Sentry's Kotlin Multiplatform Gradle Plugin."
55
---
66

7-
The [Sentry Kotlin Multiplatform Gradle Plugin](https://github.com/getsentry/sentry-kotlin-multiplatform/tree/main/sentry-kotlin-multiplatform-gradle-plugin) is an additional plugin that can be used to configure the Sentry SDK for Kotlin Multiplatform projects and allows an easier setup.
7+
The [Sentry Kotlin Multiplatform Gradle Plugin](https://github.com/getsentry/sentry-kotlin-multiplatform/tree/main/sentry-kotlin-multiplatform-gradle-plugin) is a plugin that simplifies the set up process. It can be used to configure the Sentry SDK for Kotlin Multiplatform projects.
88

9-
It supports the following features:
10-
- Auto installation of the Sentry Kotlin Multiplatform SDK.
11-
- Auto installation of the Sentry Cocoa SDK via Cocoapods if the Kotlin Cocoapods plugin is applied.
12-
- Automatic configuration of the Kotlin/Native linker for seamless usage with Swift Package Manager.
9+
The Gradle Plugin supports the following features:
10+
- Auto-installation of the Sentry Kotlin Multiplatform SDK.
11+
- Auto-installation of the Sentry Cocoa SDK via Cocoapods (if the Kotlin Cocoapods plugin is applied).
12+
- Automatic configuration of the Kotlin/Native linker for seamless usage with the Swift Package Manager.
1313

1414
## Setup
1515

docs/platforms/kotlin-multiplatform/features/index.mdx

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,17 @@ sidebar_order: 1
44
description: "Learn about the features of Sentry's Kotlin Multiplatform SDK."
55
---
66

7-
Sentry's Kotlin Multiplatform SDK enables automatic reporting of errors and exception.
8-
The SDK provides a unified API for all supported platforms, directly leveraging the native SDKs for each platform.
9-
Therefore it also supports the same features as the native SDKs.
7+
Sentry's Kotlin Multiplatform SDK enables automatic reporting of errors and exceptions.
8+
Because the SDK provides a unified API for all supported platforms directly leveraging the native SDKs for each platform, it also supports the same features as the native SDKs. Click on a link below to see relevant features for your platform:
109

1110
- [Apple features](/platforms/apple/features)
1211
- [Android features](/platforms/android/features)
1312
- [Java features](/platforms/java/features)
1413

1514
<Note>
16-
Some functionality might not yet be available in the shared Kotlin Multiplatform layer therefore it might be necessary to use the native SDKs directly or write your own platform specific code.
15+
Some functionality may not be available in the shared Kotlin Multiplatform layer yet. You may have to use the native SDKs directly, or write your own platform-specific code.
1716

18-
If you require access to the native SDK init options we recommend using the [Native Platform Options initialization](/platforms/kotlin-multiplatform/initialization-strategies/#native-platform-options).
17+
To access the native SDK init options, use the [Native Platform Options initialization](/platforms/kotlin-multiplatform/initialization-strategies/#native-platform-options).
1918
</Note>
2019

2120
## Supported Platforms

docs/platforms/kotlin-multiplatform/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,6 @@ To view and resolve the recorded error, log into [sentry.io](https://sentry.io)
4040
## Next Steps
4141

4242
- <PlatformLink to="/features">Learn more about Sentry's Kotlin Multiplatform SDK features</PlatformLink>
43-
- <PlatformLink to="/initialization-strategies">Learn about different strategies on how to initialize the SDK</PlatformLink>
44-
- <PlatformLink to="/configuration/gradle">Configuration options for the Kotlin Multiplatform Gradle Plugin</PlatformLink>
43+
- <PlatformLink to="/initialization-strategies">Learn about different ways to initialize the SDK</PlatformLink>
44+
- <PlatformLink to="/configuration/gradle">See configuration options for the Kotlin Multiplatform Gradle Plugin</PlatformLink>
4545
- <PlatformLink to="/debug-symbols">Add readable stack traces to your errors</PlatformLink>

docs/platforms/kotlin-multiplatform/initialization-strategies.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: Initialization Strategies
3-
description: "Strategies for initializing the Kotlin Multiplatform SDK."
2+
title: Initialization Options
3+
description: "Different options for initializing the Kotlin Multiplatform SDK."
44
sidebar_order: 2
55
---
66

7-
When it comes to initializing a Kotlin Multiplatform SDK, there are multiple strategies to consider:
7+
When it comes to initializing a Kotlin Multiplatform SDK, there are multiple options to consider:
88

99
- [Use native platform options directly](#native-platform-options)
1010
- [Shared initializer](#shared-initializer)
@@ -13,7 +13,7 @@ When it comes to initializing a Kotlin Multiplatform SDK, there are multiple str
1313

1414
## Where to Place Initialization Code
1515

16-
Regardless of the initialization strategy you choose, it's important to place the initialization code at an early lifecycle stage of your application to ensure the SDK is set up correctly before it is used.
16+
Regardless of the initialization option you choose, it's important to place the initialization code at an early lifecycle stage of your application to ensure the SDK is set up correctly before it is used.
1717
Here are general guidelines for placing the initialization code for different platforms:
1818

1919
```kotlin {filename:MainActivity.kt}{tabTitle: androidApp}

docs/platforms/kotlin-multiplatform/manual-setup/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Manual Setup
33
sidebar_order: 3
4-
description: "Learn how to set up the SDK manually."
4+
description: "Learn how to manually set up the SDK."
55
---
66

77
If you can't (or prefer not to) use the [gradle plugin](/platforms/kotlin-multiplatform/#install), you can follow the instructions below to configure your application manually.
@@ -90,7 +90,7 @@ If you already use SPM or prefer it over other package managers on Apple platfor
9090

9191
#### Install
9292

93-
In order to install the Sentry Kotlin Multiplatform SDK, you need to use Cocoapods and Swift Package Manager simultaneously which might seem unconventional at first, especially if you're accustomed to using SPM for all your dependencies. However, you can achieve a smooth integration by using the Kotlin Cocoapods plugin specifically for compiling and building the shared framework. You can then continue to manage all other dependencies with SPM as usual.
93+
In order to install the Sentry Kotlin Multiplatform SDK, you need to use Cocoapods and Swift Package Manager simultaneously, which might seem unconventional at first, especially if you're accustomed to using SPM for all your dependencies. However, you can achieve a smooth integration by using the Kotlin Cocoapods plugin specifically for compiling and building the shared framework. You can then continue to manage all other dependencies with SPM as usual.
9494

9595
Follow the steps for our primary installation method [Cocoapods](/platforms/kotlin-multiplatform/manual-setup/#install) to install the Sentry Kotlin Multiplatform SDK.
9696

platform-includes/getting-started-install/kotlin-multiplatform.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ plugins {
66
}
77
```
88

9-
The plugin installs the Sentry KMP dependency and if you are using the Cocoapods plugin it will also install the Sentry Cocoa dependency.
9+
The plugin installs the Sentry KMP dependency. If you're using the Cocoapods plugin, it will also install the Sentry Cocoa dependency.

0 commit comments

Comments
 (0)