getsentry / sentry-docs

Sentry's documentation (and tools to build it)
https://docs.sentry.io
Other
333 stars 1.47k forks source link

Merge Kotlin and Kotlin multiplaform into one #11848

Open bruno-garcia opened 4 days ago

bruno-garcia commented 4 days ago

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:

Some other ideas I'm not very convinced about:

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

@kahest @HazAT @buenaflor wdyt?

kahest commented 3 days ago

@bruno-garcia do you think having two items is confusing, or is the main point that it takes too much space? FWIW, KMP has much more traffic (2x that of Kotlin on the landing page), so I kinda like having KMP called out explicitly. No strong opinions against merging, but I wouldn't want to use sub-platforms/guides as we do for Apple, it's a bit annoying to maintain and only really usable if most of the content is the same IMO.