update sidebars

buenaflor · buenaflor · commit 96c5645030de · 2024-10-28T17:24:14.000+01:00
diff --git a/docs/platforms/kotlin-multiplatform/configuration/index.mdx b/docs/platforms/kotlin-multiplatform/configuration/index.mdx
@@ -1,7 +1,7 @@
 ---
 title: Configuration
 description: "Additional configuration options for the SDK."
-sidebar_order: 5
+sidebar_order: 20
 ---
 
 <PageGrid />
diff --git a/docs/platforms/kotlin-multiplatform/configuration/options.mdx b/docs/platforms/kotlin-multiplatform/configuration/options.mdx
@@ -75,12 +75,6 @@ This variable controls the total amount of breadcrumbs that should be captured.
 
 </ConfigKey>
 
-<ConfigKey name="max-cache-items">
-
-The maximum number of [envelopes](https://develop.sentry.dev/sdk/envelopes/) to keep in cache. The SDKs use envelopes to send data, such as events, attachments, user feedback, and sessions to sentry.io. An envelope can contain multiple items, such as an event with a session and two attachments. Depending on the usage of the SDK, the size of an envelope can differ. If the number of envelopes in the local cache exceeds `max-cache-items`, the SDK deletes the oldest envelope and migrates the sessions to the next envelope to maintain the integrity of your release health stats. The default is `30`.
-
-</ConfigKey>
-
 <ConfigKey name="attach-stacktrace">
 
 When enabled, stack traces are automatically attached to all messages logged. Stack traces are always attached to exceptions; however, when this option is set, stack traces are also sent with messages. This option, for instance, means that stack traces appear next to all log messages.
@@ -91,93 +85,6 @@ Grouping in Sentry is different for events with stack traces and without. As a r
 
 </ConfigKey>
 
-<ConfigKey name="send-default-pii">
-
-If this flag is enabled, certain personally identifiable information (PII) is added by active integrations. By default, no such data is sent.
-
-<Note>
-
-If you are using Sentry in your mobile app, read our [frequently asked questions about mobile data privacy](/security-legal-pii/security/mobile-privacy/) to assist with Apple App Store and Google Play app privacy details.
-
-</Note>
-
-This option is turned off by default.
-
-If you enable this option, be sure to manually remove what you don't want to send using our features for managing [_Sensitive Data_](../../data-management/sensitive-data/).
-
-</ConfigKey>
-
-<ConfigKey name="server-name">
-
-This option can be used to supply a "server name." When provided, the name of the server is sent along and persisted in the event. For many integrations, the server name actually corresponds to the device hostname, even in situations where the machine is not actually a server.
-
-Most SDKs will attempt to auto-discover this value.
-
-</ConfigKey>
-
-<ConfigKey name="in-app-include">
-
-A list of string prefixes of module names that belong to the app. This option takes precedence over `in-app-exclude`.
-
-Sentry differentiates stack frames that are directly related to your application ("in application") from stack frames that come from other packages such as the standard library, frameworks, or other dependencies. The application package is automatically marked as `inApp`. The difference is visible in [sentry.io](https://sentry.io), where only the "in application" frames are displayed by default.
-
-</ConfigKey>
-
-<ConfigKey name="in-app-exclude">
-
-A list of string prefixes of module names that do not belong to the app, but rather to third-party packages. Modules considered not part of the app will be hidden from stack traces by default.
-
-This option can be overridden using <PlatformIdentifier name="in-app-include" />.
-
-</ConfigKey>
-
-<ConfigKey name="ignored-exceptions-for-type">
-
-A list of exception types that will be filtered out before sending to Sentry.
-
-</ConfigKey>
-
-<ConfigKey name="max-request-body-size">
-
-This parameter controls whether integrations should capture HTTP request bodies. It can be set to one of the following values:
-
-- `never`: Request bodies are never sent.
-- `small`: Only small request bodies will be captured. The cutoff for small depends on the SDK (typically 4KB).
-- `medium`: Medium and small requests will be captured (typically 10KB).
-- `always`: The SDK will always capture the request body as long as Sentry can make sense of it.
-
-</ConfigKey>
-
-<ConfigKey name="enabled">
-
-Specifies whether this SDK should send events to Sentry. Defaults to `true`. Setting this to `enabled: false` doesn't prevent all overhead from Sentry instrumentation. To disable Sentry completely, depending on environment, call `Sentry.init` conditionally.
-
-</ConfigKey>
-
-<ConfigKey name="send-client-reports">
-
-Set this boolean to `false` to disable sending of client reports. Client reports are a protocol feature that let clients send status reports about themselves to Sentry. They are currently mainly used to emit outcomes for events that were never sent.
-
-_(New in version 6.0.0)_
-
-</ConfigKey>
-
-## Integration Configuration
-
-For many platform SDKs integrations can be configured alongside it. On some platforms that happen as part of the `init()` call, in some others, different patterns apply.
-
-<ConfigKey name="integrations" />
-
-In some SDKs, the integrations are configured through this parameter on library initialization. For more information, please see our documentation for a specific integration.
-
-<ConfigKey name="default-integrations" notSupported={["java", "dart"]} />
-
-This can be used to disable integrations that are added by default. When set to `false`, no default integrations are added.
-
-<ConfigKey name="auto-enabling-integrations" supported={["python"]} />
-
-This can be used to disable integrations that are enabled by default if the SDK detects that the corresponding framework or library is installed. When set to `false`, none of these integrations will be enabled by default, even if the corresponding framework/library is detected.
-
 ## Hooks
 
 These options can be used to hook the SDK in various ways to customize the reporting of events.
@@ -203,36 +110,8 @@ The callback typically gets a second argument (called a "hint") which contains t
 
 </ConfigKey>
 
-## Transport Options
-
-Transports are used to send events to Sentry. Transports can be customized to some degree to better support highly specific deployments.
-
-<ConfigKey name="transport">
-
-Switches out the transport used to send events. How this works depends on the SDK. It can, for instance, be used to capture events for unit-testing or to send it through some more complex setup that requires proxy authentication.
-
-</ConfigKey>
-
-<ConfigKey name="http-proxy">
-
-When set, a proxy can be configured that should be used for outbound requests. This is also used for HTTPS requests unless a separate `https-proxy` is configured. However, not all SDKs support a separate HTTPS proxy. SDKs will attempt to default to the system-wide configured proxy, if possible. For instance, on Unix systems, the `http_proxy` environment variable will be picked up.
-
-</ConfigKey>
-
-<ConfigKey name="shutdown-timeout">
-
-Controls how many seconds to wait before shutting down. Sentry SDKs send events from a background queue. This queue is given a certain amount to drain pending events. The default is SDK specific but typically around two seconds. Setting this value too low may cause problems for sending events from command line applications. Setting the value too high will cause the application to block for a long time for users experiencing network connectivity problems.
-
-</ConfigKey>
-
 ## Tracing Options
 
-<ConfigKey name="enable-tracing">
-
-A boolean value, if true, transactions and trace data will be generated and captured. This will set the <PlatformIdentifier name="traces-sample-rate" /> to the recommended default of 1.0 if <PlatformIdentifier name="traces-sample-rate" /> is not defined. Note that <PlatformIdentifier name="traces-sample-rate" /> and <PlatformIdentifier name="traces-sampler" /> take precedence over this option.
-
-</ConfigKey>
-
 <ConfigKey name="traces-sample-rate">
 
 A number between 0 and 1, controlling the percentage chance a given transaction will be sent to Sentry. (0 represents 0% while 1 represents 100%.) Applies equally to all transactions created in the app. Either this or <PlatformIdentifier name="traces-sampler" /> must be defined to enable tracing.
@@ -256,9 +135,3 @@ String entries do not have to be full matches, meaning the URL of a request is m
 If <PlatformIdentifier name="trace-propagation-targets" /> is not provided, trace data is attached to every outgoing request from the instrumented client.
 
 </ConfigKey>
-
-<ConfigKey name="trace-options-requests">
-
-Set this boolean to `false` to disable tracing for `OPTIONS` requests. This options default value will likely be changed in the next major version, meaning you will have to set it to `true` if you want to keep tracing `OPTIONS` requests.
-
-</ConfigKey>
diff --git a/docs/platforms/kotlin-multiplatform/debug-symbols/index.mdx b/docs/platforms/kotlin-multiplatform/debug-symbols/index.mdx
@@ -1,7 +1,7 @@
 ---
 title: Upload Debug Symbols
 description: "Learn more about how to upload debug symbols in Sentry Kotlin Multiplatform."
-sidebar_order: 4
+sidebar_order: 6
 ---
 
 To symbolicate your stack traces, you need to provide debug information to Sentry.
diff --git a/docs/platforms/kotlin-multiplatform/features/index.mdx b/docs/platforms/kotlin-multiplatform/features/index.mdx
@@ -1,6 +1,6 @@
 ---
 title: Features
-sidebar_order: 0
+sidebar_order: 1
 description: "Learn about the features of Sentry's Kotlin Multiplatform SDK."
 ---
 
diff --git a/docs/platforms/kotlin-multiplatform/index.mdx b/docs/platforms/kotlin-multiplatform/index.mdx
@@ -1,7 +1,6 @@
 ---
 title: Kotlin Multiplatform
 caseStyle: camelCase
-fallbackPlatform: java
 supportLevel: production
 sdk: sentry.kotlin.kmp
 categories:
@@ -41,6 +40,6 @@ To view and resolve the recorded error, log into [sentry.io](https://sentry.io)
 ## Next Steps
 
 - <PlatformLink to="/features">Learn more about Sentry's Kotlin Multiplatform SDK features</PlatformLink>
-- <PlatformLink to="/initialization-strategies">Get to know different ways initialize the SDK</PlatformLink>
+- <PlatformLink to="/initialization-stra">Get to know different ways initialize the SDK</PlatformLink>
 - <PlatformLink to="/configuration/gradle">Configuration options for the Kotlin Multiplatform Gradle Plugin</PlatformLink>
 - <PlatformLink to="/debug-symbols">Add readable stack traces to your errors</PlatformLink>
diff --git a/docs/platforms/kotlin-multiplatform/initialization-strategies.mdx b/docs/platforms/kotlin-multiplatform/initialization-strategies.mdx
@@ -1,7 +1,7 @@
 ---
 title: Initialization Strategies
 description: "Strategies for initializing the Kotlin Multiplatform SDK."
-sidebar_order: 3
+sidebar_order: 2
 ---
 
 When it comes to initializing a Kotlin Multiplatform SDK, there are multiple strategies to consider:
@@ -16,9 +16,7 @@ When it comes to initializing a Kotlin Multiplatform SDK, there are multiple str
 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.
 Here are general guidelines for placing the initialization code for different platforms:
 
-### Android
-
-```kotlin {filename:MainActivity.kt}
+```kotlin {filename:MainActivity.kt}{tabTitle: androidApp}
 import your.kmp.app.initializeSentry
 
 class YourApplication : Application() {
@@ -28,19 +26,25 @@ class YourApplication : Application() {
    }
 }
 ```
-
-### iOS
-
-```swift {filename:AppDelegate.swift}
+```swift {tabTitle: iosApp}
 import shared
 
 func application(
     _ application: UIApplication,
     didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil
 ) -> Bool {
-    AppSetupKt.initializeSentry()
+    SentrySetupKt.initializeSentry()
     return true
 }
+
+// OR if you're using SwiftUI:
+
+@main
+struct SwiftUIApp: App {
+    init() {
+        initializeSentry()
+    }
+}
 ```
 
 ## Native Platform Options
@@ -106,10 +110,10 @@ The shared initializer approach involves initializing the SDK in your shared cod
 
 Using a shared initializer provides a single source of truth for your SDK's configuration options. This can simplify maintenance and debugging efforts, as you only need to update one codebase for all platforms.
 
-To initialize the SDK, create a Kotlin file in your `commonMain` (such as `AppSetup.kt` or whatever you decide to call it), and write an initialization function. You'll then be able to call it in an early lifecycle stage in your platforms.
+To initialize the SDK, create a Kotlin file in your `commonMain` (such as `SentrySetup.kt` or whatever you decide to call it), and write an initialization function. You'll then be able to call it in an early lifecycle stage in your platforms.
 
 
-```kotlin {filename:AppSetup.kt}
+```kotlin {filename:SentrySetup.kt}
 import io.sentry.kotlin.multiplatform.Sentry
 import io.sentry.kotlin.multiplatform.SentryOptions
 
@@ -133,7 +137,7 @@ If you need to use the respective platform's options directly, you should use th
 
 ### Common
 
-```kotlin {filename:commonMain/AppSetup.kt}
+```kotlin {filename:commonMain/SentrySetup.kt}
 import io.sentry.kotlin.multiplatform.Context
 
 expect fun initializeSentry()
@@ -142,7 +146,7 @@ expect fun initializeSentry()
 ### androidMain
 
 
-```kotlin {filename:androidMain/AppSetup.kt}
+```kotlin {filename:androidMain/SentrySetup.kt}
 import io.sentry.kotlin.multiplatform.Sentry
 import io.sentry.kotlin.multiplatform.Context
 
@@ -157,7 +161,7 @@ actual fun initializeSentry() {
 ### iosMain
 
 
-```kotlin {filename:iosMain/AppSetup.kt}
+```kotlin {filename:iosMain/SentrySetup.kt}
 import io.sentry.kotlin.multiplatform.Sentry
 import io.sentry.kotlin.multiplatform.Context
 
diff --git a/docs/platforms/kotlin-multiplatform/manual-setup/index.mdx b/docs/platforms/kotlin-multiplatform/manual-setup/index.mdx
@@ -1,6 +1,6 @@
 ---
 title: Manual Setup
-sidebar_order: 1
+sidebar_order: 3
 description: "Learn how to set up the SDK manually."
 ---
 
diff --git a/docs/platforms/kotlin-multiplatform/native-access-sdk.mdx b/docs/platforms/kotlin-multiplatform/native-access-sdk.mdx
@@ -1,7 +1,7 @@
 ---
 title: Native Access to the SDK
 description: "How to directly access the SDK without the shared module."
-sidebar_order: 8
+sidebar_order: 4
 ---
 
 If you need to access the SDK directly in your native platform without the shared module, you first need to change the dependency configuration from `implementation(...)` to `api(...)`:
diff --git a/docs/platforms/kotlin-multiplatform/usage/index.mdx b/docs/platforms/kotlin-multiplatform/usage/index.mdx
@@ -1,7 +1,7 @@
 ---
 title: Usage
 description: "Use the SDK to manually capture errors and other events."
-sidebar_order: 10
+sidebar_order: 5
 ---
 
 Sentry's SDK hooks into your runtime environment and automatically reports errors, uncaught exceptions, and unhandled rejections as well as other types of errors depending on the platform.
