diff --git a/build.gradle.kts b/build.gradle.kts index 20d4aceb..967269ec 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -70,6 +70,8 @@ dependencies { dokka(project(":core:")) dokka(project(":connectors:supabase")) dokka(project(":compose:")) + dokka(project(":integrations:room")) + dokka(project(":integrations:sqldelight")) } dokka { @@ -97,9 +99,11 @@ develocity { tasks.register("serveDokka") { group = "dokka" dependsOn("dokkaGenerate") + val rootProvider = layout.buildDirectory.dir("dokka/html") + doLast { + val root = rootProvider.get().asFile val server = HttpServer.create(InetSocketAddress(0), 0) - val root = file("build/dokka/html") val handler = com.sun.net.httpserver.HttpHandler { exchange: HttpExchange -> diff --git a/integrations/room/README.md b/integrations/room/README.md index 4bc1e2bd..31925dd1 100644 --- a/integrations/room/README.md +++ b/integrations/room/README.md @@ -1,5 +1,8 @@ # PowerSync Room integration +> [!NOTE] +> Note that this package is currently in alpha. + This module provides the ability to use PowerSync with Room databases. This module aims for complete Room support, meaning that: @@ -7,6 +10,8 @@ Room support, meaning that: 2. Room and PowerSync cooperate on the write connection, avoiding "database is locked errors". 3. Changes from Room trigger a CRUD upload. +For more details on using this module, see its page on the [PowerSync documentation](https://docs.powersync.com/client-sdk-references/kotlin-multiplatform/libraries/room). + ## Setup Add a dependency on `com.powersync:integration-room` with the same version you use for the main diff --git a/integrations/sqldelight/README.md b/integrations/sqldelight/README.md index c60d1dd8..de94ad7f 100644 --- a/integrations/sqldelight/README.md +++ b/integrations/sqldelight/README.md @@ -1,8 +1,13 @@ ## PowerSync SQLDelight driver +> [!NOTE] +> Note that this package is currently in beta. + This library provides the `PowerSyncDriver` class, which implements an `SqlDriver` for `SQLDelight` backed by PowerSync. +For more details on using this module, see its page on the [PowerSync documentation](https://docs.powersync.com/client-sdk-references/kotlin-multiplatform/libraries/sqldelight). + ## Setup Add a dependency on `com.powersync:integration-sqldelight`, using the same version you use for the diff --git a/plugins/build-plugin/src/main/kotlin/dokka-convention.gradle.kts b/plugins/build-plugin/src/main/kotlin/dokka-convention.gradle.kts index 5de507b8..2cca96bb 100644 --- a/plugins/build-plugin/src/main/kotlin/dokka-convention.gradle.kts +++ b/plugins/build-plugin/src/main/kotlin/dokka-convention.gradle.kts @@ -1,3 +1,5 @@ +import java.net.URI + plugins { id("org.jetbrains.dokka") } @@ -28,7 +30,7 @@ dokka { sourceLink { localDirectory.set(project.rootDir) remoteUrl.set(commit.map { commit -> - uri("https://github.com/powersync-ja/powersync-kotlin/tree/${commit.trim()}/") + URI.create("https://github.com/powersync-ja/powersync-kotlin/tree/${commit.trim()}/") }) remoteLineSuffix.set("#L") }