From e80fe88d231f639c57c0aa56842475453870ec26 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ivan=20=E2=80=9CCLOVIS=E2=80=9D=20Canet?=
 <ivan.canet@gmail.com>
Date: Sat, 21 Dec 2024 14:52:00 +0100
Subject: [PATCH 1/3] upgrade: Gradle Conventions 1.6.0

See https://gitlab.com/opensavvy/automation/gradle-conventions/-/releases/1.6.0
---
 .gitlab-ci.yml                            | 2 +-
 .idea/runConfigurations/Documentation.xml | 2 +-
 build.gradle.kts                          | 2 +-
 gradle.properties                         | 4 ++++
 gradle/conventions/settings.gradle.kts    | 2 +-
 settings.gradle.kts                       | 2 +-
 6 files changed, 9 insertions(+), 5 deletions(-)

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 2417ad1f..14db420f 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -301,7 +301,7 @@ dokka:
 
   script:
     - >
-      ./gradlew :dokkatooGeneratePublicationHtml
+      ./gradlew :dokkaGeneratePublicationHtml
       --no-configuration-cache
       -PappVersion=$project_version
 
diff --git a/.idea/runConfigurations/Documentation.xml b/.idea/runConfigurations/Documentation.xml
index 862dd23d..e31ca5b5 100644
--- a/.idea/runConfigurations/Documentation.xml
+++ b/.idea/runConfigurations/Documentation.xml
@@ -10,7 +10,7 @@
       </option>
       <option name="taskNames">
         <list>
-          <option value=":dokkatooGeneratePublicationHtml" />
+          <option value=":dokkaGeneratePublicationHtml" />
         </list>
       </option>
       <option name="vmOptions" />
diff --git a/build.gradle.kts b/build.gradle.kts
index 813b5eb3..56f30944 100644
--- a/build.gradle.kts
+++ b/build.gradle.kts
@@ -21,7 +21,7 @@ plugins {
 
 dependencies {
 	// List the 'library' projects
-	// dokkatoo(projects.core)
+	// dokka(projects.core)
 }
 
 // region Check the users of the project didn't forget to rename the group
diff --git a/gradle.properties b/gradle.properties
index 75d1cef3..30acaafa 100644
--- a/gradle.properties
+++ b/gradle.properties
@@ -20,3 +20,7 @@ org.gradle.caching=true
 # Configuration on demand allows Gradle to only configure projects which take part in the build.
 # See https://docs.gradle.org/current/userguide/multi_project_configuration_and_execution.html#sec:configuration_on_demand
 org.gradle.configureondemand=true
+
+# Dokka v2
+# See https://kotl.in/dokka-gradle-migration
+org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled
diff --git a/gradle/conventions/settings.gradle.kts b/gradle/conventions/settings.gradle.kts
index 768d1811..299d08ed 100644
--- a/gradle/conventions/settings.gradle.kts
+++ b/gradle/conventions/settings.gradle.kts
@@ -45,7 +45,7 @@ pluginManagement {
 }
 
 plugins {
-	id("dev.opensavvy.conventions.settings") version "1.5.2"
+	id("dev.opensavvy.conventions.settings") version "1.6.0"
 }
 
 enableFeaturePreview("TYPESAFE_PROJECT_ACCESSORS")
diff --git a/settings.gradle.kts b/settings.gradle.kts
index 30990b4b..ee219fea 100644
--- a/settings.gradle.kts
+++ b/settings.gradle.kts
@@ -49,7 +49,7 @@ pluginManagement {
 }
 
 plugins {
-	id("dev.opensavvy.conventions.settings") version "1.5.2"
+	id("dev.opensavvy.conventions.settings") version "1.6.0"
 }
 
 include(
-- 
2.51.2


From 71699b3a0c181f68fa79000f6bdbb35e70f07f83 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ivan=20=E2=80=9CCLOVIS=E2=80=9D=20Canet?=
 <ivan.canet@gmail.com>
Date: Sat, 21 Dec 2024 15:13:59 +0100
Subject: [PATCH 2/3] docs(website): Embed the Dokka output into the docs
 website

---
 .idea/runConfigurations/Documentation.xml                | 1 +
 docs/website/.gitignore                                  | 3 +++
 docs/website/.gitlab-ci.yml                              | 3 +++
 docs/website/build.gradle.kts                            | 9 +++++++++
 docs/website/mkdocs.yml                                  | 5 ++++-
 .../template-lib/src/commonMain/kotlin/HelloWorld.kt     | 3 +++
 settings.gradle.kts                                      | 1 +
 7 files changed, 24 insertions(+), 1 deletion(-)
 create mode 100644 docs/website/build.gradle.kts

diff --git a/.idea/runConfigurations/Documentation.xml b/.idea/runConfigurations/Documentation.xml
index e31ca5b5..c2c66d2e 100644
--- a/.idea/runConfigurations/Documentation.xml
+++ b/.idea/runConfigurations/Documentation.xml
@@ -11,6 +11,7 @@
       <option name="taskNames">
         <list>
           <option value=":dokkaGeneratePublicationHtml" />
+          <option value=":docs:website:embedDokkaIntoMkDocs" />
         </list>
       </option>
       <option name="vmOptions" />
diff --git a/docs/website/.gitignore b/docs/website/.gitignore
index 16d3c4db..329639a6 100644
--- a/docs/website/.gitignore
+++ b/docs/website/.gitignore
@@ -1 +1,4 @@
 .cache
+
+# Dokka output
+api/
diff --git a/docs/website/.gitlab-ci.yml b/docs/website/.gitlab-ci.yml
index 4cf2735e..da39edec 100644
--- a/docs/website/.gitlab-ci.yml
+++ b/docs/website/.gitlab-ci.yml
@@ -2,8 +2,11 @@
 mkdocs:
   image: registry.gitlab.com/opensavvy/automation/containers/mkdocs:$ci_containers
   stage: build
+  extends: [ .os.gradle ]
+  needs: [ os.version ]
 
   before_script:
+    - ./gradlew docs:website:embedDokkaIntoMkDocs -PappVersion=$project_version
     - cd docs/website
     - ls
     - 'echo "repo_url: $CI_PROJECT_URL">>mkdocs.yml'
diff --git a/docs/website/build.gradle.kts b/docs/website/build.gradle.kts
new file mode 100644
index 00000000..25466037
--- /dev/null
+++ b/docs/website/build.gradle.kts
@@ -0,0 +1,9 @@
+plugins {
+	alias(opensavvyConventions.plugins.base)
+	id("dev.opensavvy.dokka-mkdocs")
+}
+
+dependencies {
+	// List the 'library' projects
+	// dokka(projects.core)
+}
diff --git a/docs/website/mkdocs.yml b/docs/website/mkdocs.yml
index 9ead25d7..937da819 100644
--- a/docs/website/mkdocs.yml
+++ b/docs/website/mkdocs.yml
@@ -91,5 +91,8 @@ nav:
 
   - Module2: []
 
-  - Reference:
+# !!! EMBEDDED DOKKA START, DO NOT COMMIT !!! #
+# !!! EMBEDDED DOKKA END, DO NOT COMMIT !!! #
+
+  - Reference (external):
       - reference.md
diff --git a/gradle/templates/template-lib/src/commonMain/kotlin/HelloWorld.kt b/gradle/templates/template-lib/src/commonMain/kotlin/HelloWorld.kt
index b87d0d9c..fb7defd6 100644
--- a/gradle/templates/template-lib/src/commonMain/kotlin/HelloWorld.kt
+++ b/gradle/templates/template-lib/src/commonMain/kotlin/HelloWorld.kt
@@ -1,3 +1,6 @@
 package opensavvy.playground.core
 
+/**
+ * A hello world message.
+ */
 const val message = "Hello World!"
diff --git a/settings.gradle.kts b/settings.gradle.kts
index ee219fea..be402034 100644
--- a/settings.gradle.kts
+++ b/settings.gradle.kts
@@ -53,6 +53,7 @@ plugins {
 }
 
 include(
+	"docs:website",
 	"gradle:templates:template-app",
 	"gradle:templates:template-lib",
 )
-- 
2.51.2


From 8d6133041160a3bef975fdd4fd5fb86298c430a0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ivan=20=E2=80=9CCLOVIS=E2=80=9D=20Canet?=
 <ivan.canet@gmail.com>
Date: Sun, 29 Dec 2024 12:54:34 +0100
Subject: [PATCH 3/3] docs(website): Embed Dokka output

---
 docs/website/build.gradle.kts | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/docs/website/build.gradle.kts b/docs/website/build.gradle.kts
index 25466037..b77be79f 100644
--- a/docs/website/build.gradle.kts
+++ b/docs/website/build.gradle.kts
@@ -1,3 +1,19 @@
+/*
+ * Copyright (c) 2024, OpenSavvy and contributors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 plugins {
 	alias(opensavvyConventions.plugins.base)
 	id("dev.opensavvy.dokka-mkdocs")
@@ -5,5 +21,9 @@ plugins {
 
 dependencies {
 	// List the 'library' projects
-	// dokka(projects.core)
+	dokka(projects.annotations)
+	// dokka(projects.bson) // Uncomment after https://gitlab.com/opensavvy/automation/dokka-material-mkdocs/-/issues/8
+	dokka(projects.dsl)
+	dokka(projects.driverSync)
+	dokka(projects.driverCoroutines)
 }
-- 
2.51.2