Add compose module to docs. Test pages again. Fix image trailing slash. Internalize buildconfig.

Author: stevensJourney

.github/workflows/docs-deploy.yml

@@ -2,7 +2,7 @@ name: Deploy Docs
 
 on:
   push:
-    branches: [ 'main' ]
+    branches: [ 'api-ref', 'main' ]
 
 permissions:
   contents: read

build.gradle.kts

@@ -70,6 +70,7 @@ tasks.getByName<Delete>("clean") {
 dependencies {
     dokka(project(":core:"))
     dokka(project(":connectors:supabase"))
+    dokka(project(":compose:"))
 }
 
 dokka {
@@ -79,6 +80,7 @@ dokka {
 // Serve the generated Dokka documentation using a simple HTTP server
 // File changes are not watched here
 tasks.register("serveDokka") {
+    group = "dokka"
     dependsOn("dokkaGenerate")
     doLast {
         val server = HttpServer.create(InetSocketAddress(0), 0)

compose/build.gradle.kts

@@ -8,6 +8,7 @@ plugins {
     alias(libs.plugins.compose.compiler)
     alias(libs.plugins.kotlinter)
     id("com.powersync.plugins.sonatype")
+    id("dokka-convention")
 }
 
 kotlin {
@@ -45,3 +46,7 @@ android {
 }
 
 setupGithubRepository()
+
+dokka {
+    moduleName.set("PowerSync Compose")
+}

core/src/androidMain/kotlin/BuildConfig.kt

@@ -1,5 +1,5 @@
 @Suppress("EXPECT_ACTUAL_CLASSIFIERS_ARE_IN_BETA_WARNING")
-public actual object BuildConfig {
-    public actual val isDebug: Boolean
+internal actual object BuildConfig {
+    actual val isDebug: Boolean
         get() = com.powersync.BuildConfig.DEBUG
 }

core/src/appleMain/kotlin/BuildConfig.kt

@@ -2,7 +2,7 @@ import kotlin.experimental.ExperimentalNativeApi
 import kotlin.native.Platform
 
 @Suppress("EXPECT_ACTUAL_CLASSIFIERS_ARE_IN_BETA_WARNING")
-public actual object BuildConfig {
+internal actual object BuildConfig {
     @OptIn(ExperimentalNativeApi::class)
-    public actual val isDebug: Boolean = Platform.isDebugBinary
+    actual val isDebug: Boolean = Platform.isDebugBinary
 }

core/src/commonMain/kotlin/BuildConfig.kt

@@ -1,4 +1,4 @@
 @Suppress("EXPECT_ACTUAL_CLASSIFIERS_ARE_IN_BETA_WARNING")
-public expect object BuildConfig {
-    public val isDebug: Boolean
+internal expect object BuildConfig {
+    val isDebug: Boolean
 }

core/src/jvmMain/kotlin/BuildConfig.kt

@@ -1,12 +1,12 @@
 @Suppress("EXPECT_ACTUAL_CLASSIFIERS_ARE_IN_BETA_WARNING")
-public actual object BuildConfig {
+internal actual object BuildConfig {
     /*
       To debug on the JVM, you can:
       - Set the com.powersync.debug property with System.setProperty("com.powersync.debug", true) BEFORE calling any powersync API.
       - Start your java program with the -Dcom.powersync.debug=true command line argument.
       - Set the POWERSYNC_JVM_DEBUG environment variable to "true" before starting your program.
      */
-    public actual val isDebug: Boolean =
+    actual val isDebug: Boolean =
         System.getProperty("com.powersync.debug") == "true" ||
             System.getenv("POWERSYNC_JVM_DEBUG") == "true"
 }

docs/assets/dokka-templates/includes/footer.ftl

@@ -6,16 +6,16 @@
     <strong class="footer-title">Community</strong>
     <div class="footer-icon-row">
       <a href="https://discord.gg/powersync" target="_blank">
-        <img src="./${pathToRoot}/images/discord.svg" loading="lazy" alt="Discord" height="24">
+        <img src="./${pathToRoot}images/discord.svg" loading="lazy" alt="Discord" height="24">
       </a>
       <a href="https://twitter.com/powersync_" target="_blank">
-        <img src="./${pathToRoot}/images/x.svg" loading="lazy" alt="Twitter" height="20">
+        <img src="./${pathToRoot}images/x.svg" loading="lazy" alt="Twitter" height="20">
       </a>
       <a href="https://www.youtube.com/@powersync_" target="_blank">
-        <img src="./${pathToRoot}/images/youtube.svg" loading="lazy" alt="YouTube" width="32" height="28">
+        <img src="./${pathToRoot}images/youtube.svg" loading="lazy" alt="YouTube" width="32" height="28">
       </a>
       <a href="https://www.linkedin.com/showcase/journeyapps-powersync/" target="_blank">
-        <img src="./${pathToRoot}/images/linkedin.svg" loading="lazy" alt="LinkedIn" height="24">
+        <img src="./${pathToRoot}images/linkedin.svg" loading="lazy" alt="LinkedIn" height="24">
       </a>
     </div>
   </div>
@@ -24,10 +24,10 @@
     <strong class="footer-title">More</strong>
     <div class="footer-icon-row">
       <a href="https://github.com/powersync-ja" target="_blank">
-        <img src="./${pathToRoot}/images/github.svg" loading="lazy" alt="GitHub" height="24">
+        <img src="./${pathToRoot}images/github.svg" loading="lazy" alt="GitHub" height="24">
       </a>
       <a href="https://www.powersync.com/" target="_blank">
-        <img src="./${pathToRoot}/images/web.svg" loading="lazy" alt="Website" height="30">
+        <img src="./${pathToRoot}images/web.svg" loading="lazy" alt="Website" height="30">
       </a>
     </div>
   </div>