Skip to content

Commit 4dea227

Browse files
authored
Include Room and SQLDelight modules in docs (#264)
1 parent 0ad3517 commit 4dea227

File tree

4 files changed

+18
-2
lines changed

4 files changed

+18
-2
lines changed

build.gradle.kts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,8 @@ dependencies {
7070
dokka(project(":core:"))
7171
dokka(project(":connectors:supabase"))
7272
dokka(project(":compose:"))
73+
dokka(project(":integrations:room"))
74+
dokka(project(":integrations:sqldelight"))
7375
}
7476

7577
dokka {
@@ -97,9 +99,11 @@ develocity {
9799
tasks.register("serveDokka") {
98100
group = "dokka"
99101
dependsOn("dokkaGenerate")
102+
val rootProvider = layout.buildDirectory.dir("dokka/html")
103+
100104
doLast {
105+
val root = rootProvider.get().asFile
101106
val server = HttpServer.create(InetSocketAddress(0), 0)
102-
val root = file("build/dokka/html")
103107

104108
val handler =
105109
com.sun.net.httpserver.HttpHandler { exchange: HttpExchange ->

integrations/room/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,17 @@
11
# PowerSync Room integration
22

3+
> [!NOTE]
4+
> Note that this package is currently in alpha.
5+
36
This module provides the ability to use PowerSync with Room databases. This module aims for complete
47
Room support, meaning that:
58

69
1. Changes synced from PowerSync automatically update your Room `Flow`s.
710
2. Room and PowerSync cooperate on the write connection, avoiding "database is locked errors".
811
3. Changes from Room trigger a CRUD upload.
912

13+
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).
14+
1015
## Setup
1116

1217
Add a dependency on `com.powersync:integration-room` with the same version you use for the main

integrations/sqldelight/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
11
## PowerSync SQLDelight driver
22

3+
> [!NOTE]
4+
> Note that this package is currently in beta.
5+
36
This library provides the `PowerSyncDriver` class, which implements an `SqlDriver` for `SQLDelight`
47
backed by PowerSync.
58

9+
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).
10+
611
## Setup
712

813
Add a dependency on `com.powersync:integration-sqldelight`, using the same version you use for the

plugins/build-plugin/src/main/kotlin/dokka-convention.gradle.kts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import java.net.URI
2+
13
plugins {
24
id("org.jetbrains.dokka")
35
}
@@ -28,7 +30,7 @@ dokka {
2830
sourceLink {
2931
localDirectory.set(project.rootDir)
3032
remoteUrl.set(commit.map { commit ->
31-
uri("https://github.com/powersync-ja/powersync-kotlin/tree/${commit.trim()}/")
33+
URI.create("https://github.com/powersync-ja/powersync-kotlin/tree/${commit.trim()}/")
3234
})
3335
remoteLineSuffix.set("#L")
3436
}

0 commit comments

Comments
 (0)