Skip to content

docs: modernize KMP README, add llms.txt, and add OpenRewrite 8.x migration recipe - #644

Merged
oshai merged 1 commit into
masterfrom
docs/modernize-kmp-llms-openrewrite
Nov 14, 2026
Merged

oshai merged 1 commit into
masterfrom
docs/modernize-kmp-llms-openrewrite

Conversation

@oshai

@oshai oshai commented Nov 14, 2026

Copy link
Copy Markdown
Owner

Summary

  • README.md Modernization:
    • Adds Gradle Kotlin DSL (build.gradle.kts), Gradle Version Catalog (gradle/libs.versions.toml), Kotlin Multiplatform (commonMain), Groovy, and Maven 8.0.7 installation snippets, and updates the slf4j-simple example to 2.0.20.
    • Replaces the legacy "experimental multiplatform support" note and 2018 issue links (#21, #45) with a production Kotlin Multiplatform target overview across 20+ targets (JVM, Android, JS, wasmJs/wasmWasi, Apple os_log, Linux, Windows, and Android Native) and KotlinLoggingConfiguration.direct.logLevel.
    • Adds the OpenSSF Scorecard badge, replaces the dead saltnlight5.blogspot.co.il link with https://www.slf4j.org/manual.html, upgrades http://stackoverflow.com links to https://, and links to the OpenRewrite migration guide, Dokka API docs, and llms.txt.
    • Updates RELEASING.md Step 6 so post-release version bumps keep README.md, llms.txt, and docs/openrewrite/ synchronized.
  • llms.txt + GitHub Pages Deployment:
    • Adds llms.txt following the llmstxt.org specification with canonical 8.x coordinates, explicit guardrails against legacy io.github.microutils / mu.* and removed 8.0.0 eager String? overloads, and idiomatic lazy/fluent/MDC/coroutines examples.
    • Updates .github/workflows/github-pages.yml to copy llms.txt into build/dokka/html/llms.txt so it is served at https://oshai.github.io/kotlin-logging/llms.txt.
  • OpenRewrite Migration Recipe (docs/openrewrite/):
    • Adds docs/openrewrite/rewrite.yml (io.github.oshai.kotlinlogging.UpgradeToKotlinLogging8) and docs/openrewrite/README.md with empirically verified Gradle (--init-script and build.gradle.kts) and Maven commands plus manual follow-up notes (slf4j-api, 8.0.0 lazy {} lambdas, and KotlinLoggingConfiguration.direct.logLevel).

Checklist

  • Empirically tested docs/openrewrite/rewrite.yml against a sample Kotlin 3.0.5 project (./gradlew rewriteRun + ./gradlew compileKotlin on 8.0.7)
  • CI passes across Linux, macOS, and Windows

@oshai
oshai merged commit 2b15951 into master Nov 14, 2026
8 checks passed
@oshai
oshai deleted the docs/modernize-kmp-llms-openrewrite branch November 14, 2026 13:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant