diff --git a/dokka-mkdocs/src/main/kotlin/DokkaMkDocsPlugin.kt b/dokka-mkdocs/src/main/kotlin/DokkaMkDocsPlugin.kt index 05e4658..b2caac6 100644 --- a/dokka-mkdocs/src/main/kotlin/DokkaMkDocsPlugin.kt +++ b/dokka-mkdocs/src/main/kotlin/DokkaMkDocsPlugin.kt @@ -175,7 +175,7 @@ abstract class DokkaMkDocsPlugin : DokkaFormatPlugin(formatName = "mkdocs") { when { file == root -> { - builder.appendLine(" - Reference (experimental):") + builder.appendLine(" - Reference:") children.forEach { it.render(builder, 1) } } -- 2.51.2 From 196ad003f567db3fb21cf982098fddfdc424914f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ivan=20=E2=80=9CCLOVIS=E2=80=9D=20Canet?= Date: Sat, 14 Mar 2026 21:00:10 +0100 Subject: [PATCH 2/4] docs: Mark the project as beta At this point, we expect no breaking changes, but we expect bug fixes. --- aggregator/README.md | 2 +- dokka-mkdocs/README.md | 2 +- renderer/README.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/aggregator/README.md b/aggregator/README.md index 0138d5c..138bd40 100644 --- a/aggregator/README.md +++ b/aggregator/README.md @@ -3,7 +3,7 @@ Dokka plugin that combines multiple modules generated with the Material for MkDocs format. - + This plugin is usually not used directly. Instead, use one of the Gradle plugins to configure Dokka. diff --git a/dokka-mkdocs/README.md b/dokka-mkdocs/README.md index 37c0365..1314df0 100644 --- a/dokka-mkdocs/README.md +++ b/dokka-mkdocs/README.md @@ -3,7 +3,7 @@ Gradle plugin to configure Dokka 2+ with Material for MkDocs. - + This is a Gradle plugin using Dokka to extract Kotlin documentation and embed it in a Material for MkDocs site. To learn more about the project, see [the documentation](https://dokka-mkdocs.opensavvy.dev/). diff --git a/renderer/README.md b/renderer/README.md index eed16f6..8e62950 100644 --- a/renderer/README.md +++ b/renderer/README.md @@ -3,7 +3,7 @@ Dokka plugin to generate a Material for MkDocs compatible Markdown collection of files. - + This plugin is usually not used directly. Instead, use one of the Gradle plugins to configure Dokka. -- 2.51.2 From 8b335f5c7f3d2a38f8588ea4e570af8e1797444e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ivan=20=E2=80=9CCLOVIS=E2=80=9D=20Canet?= Date: Sat, 14 Mar 2026 22:14:58 +0100 Subject: [PATCH 3/4] docs(website): Update the stability mentions in the home page --- docs/website/docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/website/docs/index.md b/docs/website/docs/index.md index b6c0956..21a766d 100644 --- a/docs/website/docs/index.md +++ b/docs/website/docs/index.md @@ -12,4 +12,4 @@ Dokka in Material for MkDocs is a Gradle plugin using Dokka to extract documenta This plugin should work for any kind of project supported by Dokka: Kotlin/JVM, Kotlin/Multiplatform, etc. This also includes extracting Java source comments from mixed Java/Kotlin projects. -This project is very early in development. If you find something missing, or a stability issue, please [create an issue](https://gitlab.com/opensavvy/automation/dokka-material-mkdocs/-/issues/new) or [email us](mailto:contact-project+opensavvy-automation-dokka-material-mkdocs-60473792-issue-@incoming.gitlab.com). +The project has reached beta stability: we expect that there may be bugs or edge cases left, but we don't intend on breaking URLs. If you find something missing, or a stability issue, please [create an issue](https://gitlab.com/opensavvy/automation/dokka-material-mkdocs/-/issues/new) or [email us](mailto:contact-project+opensavvy-automation-dokka-material-mkdocs-60473792-issue-@incoming.gitlab.com). -- 2.51.2 From d8d19d2ae450cbefe5e496d788a7e0bc09639ac2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ivan=20=E2=80=9CCLOVIS=E2=80=9D=20Canet?= Date: Sat, 14 Mar 2026 22:53:55 +0100 Subject: [PATCH 4/4] docs(website): Redirect users to the news section instead of to MavenCentral --- docs/website/docs/setup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/website/docs/setup.md b/docs/website/docs/setup.md index b309429..0fd9bd3 100644 --- a/docs/website/docs/setup.md +++ b/docs/website/docs/setup.md @@ -35,7 +35,7 @@ dependencies { } ``` -1. Latest version:
All versions: [Release list](https://gitlab.com/opensavvy/automation/dokka-material-mkdocs/-/releases) +1. To know what the latest version is, visit [the news](news/index.md). Each Gradle project that you want to include in the website should be added to the `dependencies` block. You may include as many projects as you want.