Skip to content

Merge Kotlin and Kotlin multiplaform into one #11848

@bruno-garcia

Description

@bruno-garcia

SDK

Kotlin Multiplatform SDK

Description

We have two entries on the docs for Kotlin:
Image

It takes space in the landing page as well as the drop down.

Kotlin docs is only a landing page to route the reader to either Android, Java or Kotlin Multi-platform: https://docs.sentry.io/platforms/kotlin/
Image

It does that while showing sentry-java information the right side.
Image

Kotlin extensions, which lives under the Java docs, apply to Kotlin in general, including KMP.
https://docs.sentry.io/platforms/java/enriching-events/scopes/#kotlin-coroutines

Kotlin itself has one doc: https://kotlinlang.org/
It mentions its capabilities, including KMP.

Suggested Solution

I propose we merge both things into one area: Kotlin
Redirect all kotlin-multiplatform docs to kotlin, and move all pages there.

The landing page can have the same clarification that we have specific Android and Java (JVM) docs, including Spring Boot, elsewhere.

A smaller banner could live on top of all pages that are specific to KMP, with this clarification about Android and JVM docs.

An alternative solution is to include KMP as a sub-platform. Similar to how Apple/iOS is layed out:
Image

We could then have:

  • Kotlin - Same as today, + an include to the same Kotlin Extensions docs we have under Java
  • Kotlin - Multiplatform (contents of KMP docs today)

Some other ideas I'm not very convinced about:

  • Android -> Just a landing page with a note to go to Android?
  • All sub folders from Java?

Perhaps the docs infra could make Kotlin point to Java, but just change the icon/URL otherwise to be Kotlin?

@kahest @HazAT @buenaflor wdyt?

Metadata

Metadata

Projects

Status

Done

Status

No status

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions