Add module documentation and enhance Dokka configuration

.github/workflows/apidocs.yaml

@@ -0,0 +1,49 @@
+name: Build and Publish API Docs to GitHub Pages
+
+on:
+  release:
+    types:
+      - published
+  # Allow running this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  deploy:
+
+    permissions:
+      pages: write      # to deploy to Pages
+      id-token: write   # to verify the deployment originates from an appropriate source
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          submodules: true  # Fetch Hugo themes (true OR recursive)
+          fetch-depth: 0    # Fetch all history for .GitInfo and .Lastmod
+
+      - name: Set up JDK 21
+        uses: actions/setup-java@v5
+        with:
+          java-version: '21'
+          distribution: 'temurin'
+          cache: gradle
+
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v4
+
+      - name: Generate Dokka Site
+        run: |-
+          ./gradlew :docs:clean :docs:dokkaGenerate
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v4
+        with:
+          path: build/dokka/html
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -11,6 +11,7 @@ build/
 .idea/compiler.xml
 .idea/libraries/
 .idea
+!.idea/icon.png
 *.iws
 *.iml
 *.ipr

build.gradle.kts

@@ -1,4 +1,5 @@
 plugins {
+    id("mcp.dokka")
     alias(libs.plugins.ktlint)
     alias(libs.plugins.kover)
 }
@@ -9,6 +10,10 @@ allprojects {
 }
 
 dependencies {
+    dokka(project(":kotlin-sdk-core"))
+    dokka(project(":kotlin-sdk-client"))
+    dokka(project(":kotlin-sdk-server"))
+
     kover(project(":kotlin-sdk-core"))
     kover(project(":kotlin-sdk-client"))
     kover(project(":kotlin-sdk-server"))
@@ -20,6 +25,14 @@ subprojects {
     apply(plugin = "org.jetbrains.kotlinx.kover")
 }
 
+dokka {
+    moduleName = "MCP Kotlin SDK"
+
+    dokkaPublications.html {
+        includes.from("docs/moduledoc.md")
+    }
+}
+
 kover {
     reports {
         filters {

buildSrc/src/main/kotlin/mcp.dokka.gradle.kts

@@ -5,19 +5,35 @@ plugins {
 }
 
 dokka {
-    moduleName.set("MCP Kotlin SDK - ${project.name}")
 
     dokkaSourceSets.configureEach {
+        includes.from("Module.md")
+
+        pluginsConfiguration.html {
+            footerMessage = "Copyright © 2024-2025 Anthropic, PBC"
+        }
+
         sourceLink {
             localDirectory = projectDir.resolve("src")
             remoteUrl("https://github.com/modelcontextprotocol/kotlin-sdk/tree/main/${project.name}/src")
             remoteLineSuffix = "#L"
         }
 
         documentedVisibilities(VisibilityModifier.Public)
-    }
 
-    dokkaPublications.html {
-        outputDirectory = rootProject.layout.projectDirectory.dir("docs/${project.name}")
+        externalDocumentationLinks.register("ktor-client") {
+            url("https://api.ktor.io/ktor-client/")
+            packageListUrl("https://api.ktor.io/package-list")
+        }
+
+        externalDocumentationLinks.register("kotlinx-coroutines") {
+            url("https://kotlinlang.org/api/kotlinx.coroutines/")
+            packageListUrl("https://kotlinlang.org/api/kotlinx.coroutines/package-list")
+        }
+
+        externalDocumentationLinks.register("kotlinx-serialization") {
+            url("https://kotlinlang.org/api/kotlinx.serialization/")
+            packageListUrl("https://kotlinlang.org/api/kotlinx.serialization/package-list")
+        }
     }
-}
+}