add schema comment

Author: stevensJourney

.github/workflows/docs-deploy.yml

@@ -11,8 +11,7 @@ permissions:
 
 jobs:
   build:
-    # Need to be able to build targets
-    runs-on: macos-latest
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - name: Validate Gradle Wrapper

connectors/supabase/build.gradle.kts

@@ -8,7 +8,6 @@ plugins {
     alias(libs.plugins.androidLibrary)
     alias(libs.plugins.kotlinter)
     id("com.powersync.plugins.sonatype")
-    id("org.jetbrains.dokka") version "2.0.0"
     id("dokka-convention")
 }
 

core/src/commonMain/kotlin/com/powersync/db/schema/Schema.kt

@@ -2,15 +2,30 @@ package com.powersync.db.schema
 
 import kotlinx.serialization.Serializable
 
+/**
+ * The schema used by the database.
+ *
+ * The implementation uses the schema as a "VIEW" on top of JSON data.
+ * No migrations are required on the client.
+ */
 public data class Schema(
     val tables: List<Table>,
 ) {
     init {
         validate()
     }
 
+    /**
+     * Secondary constructor to create a schema with a variable number of tables.
+     */
     public constructor(vararg tables: Table) : this(tables.asList())
 
+    /**
+     * Validates the schema by ensuring there are no duplicate table names
+     * and that each table is valid.
+     *
+     * @throws AssertionError if duplicate table names are found.
+     */
     public fun validate() {
         val tableNames = mutableSetOf<String>()
         tables.forEach { table ->

docs/assets/base.css

@@ -2,7 +2,7 @@ plugins {
     id("org.jetbrains.dokka")
 }
 
-// Shared Dokka config
+// Shared Dokka config for additional assets
 dokka {
     pluginsConfiguration.html {
         val docsAssetsDir = rootProject.file("docs/assets")