Prepare for release 1.0.0-alpha02

.github/workflows/publish-docs.yml

@@ -64,8 +64,8 @@ jobs:
 
       - name: Relocate API References
         run: |
-          mkdir -p build/docs/${{ env.REPOSITORY }}/reference
-          cp -r build/dokka/htmlMultiModule/* build/docs/${{ env.REPOSITORY }}/reference
+          mkdir -p build/docs/${{ env.REPOSITORY }}/html
+          cp -r build/dokka/htmlMultiModule/* build/docs/${{ env.REPOSITORY }}/html
 
       - id: publish-docs
         name: Deploy Documentation

README.md

@@ -2,7 +2,7 @@
 
 ## Overview
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
-[![Maven Central](https://img.shields.io/maven-central/v/dev.teogor.stitch/bom.svg?label=Maven%20Central)](https://central.sonatype.com/search?q=g%3Adev.teogor.stitch+a%3Aapi&smo=true)
+[![Maven Central](https://img.shields.io/maven-central/v/dev.teogor.stitch/common.svg?label=Maven%20Central)](https://central.sonatype.com/search?q=g%3Adev.teogor.stitch+a%3Acommon&smo=true)
 [![API](https://img.shields.io/badge/API-24%2B-brightgreen.svg?style=flat)](https://android-arsenal.com/api?level=24)
 [![Profile](https://source.teogor.dev/badges/teogor-github.svg)](https://github.com/teogor)
 [![Portfolio](https://source.teogor.dev/badges/teogor-dev.svg)](https://source.teogor.dev/stitch)
@@ -39,8 +39,6 @@ Tired of writing repetitive Room boilerplate code? Stitch, your friendly Kotlin
 * **Coroutine-friendly Operations:** Stitch supports asynchronous data access using coroutines, ensuring a responsive and efficient user experience.
 * **Efficient KSP Integration:** Leverages Kotlin Symbol Processing for accurate and optimized code generation based on your project's specific setup.
 
-
-
 ## Documentation and Community:
 
 * **Website:** [https://source.teogor.dev/stitch](https://source.teogor.dev/stitch)

build.gradle.kts

@@ -47,7 +47,7 @@ winds {
     url = "https://source.teogor.dev/stitch"
 
     version = createVersion(1, 0, 0) {
-      alphaRelease(1)
+      alphaRelease(2)
     }
 
     inceptionYear = 2024

docs/index.md

@@ -2,7 +2,7 @@
 
 ## Overview
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
-[![Maven Central](https://img.shields.io/maven-central/v/dev.teogor.stitch/bom.svg?label=Maven%20Central)](https://central.sonatype.com/search?q=g%3Adev.teogor.stitch+a%3Aapi&smo=true)
+[![Maven Central](https://img.shields.io/maven-central/v/dev.teogor.stitch/common.svg?label=Maven%20Central)](https://central.sonatype.com/search?q=g%3Adev.teogor.stitch+a%3Acommon&smo=true)
 [![API](https://img.shields.io/badge/API-24%2B-brightgreen.svg?style=flat)](https://android-arsenal.com/api?level=24)
 [![Profile](https://source.teogor.dev/badges/teogor-github.svg)](https://github.com/teogor)
 [![Portfolio](https://source.teogor.dev/badges/teogor-dev.svg)](https://source.teogor.dev)

docs/reference.md

@@ -1,42 +1,24 @@
 ## Reference
 
 Welcome to the comprehensive API documentation for our project, meticulously crafted to empower you
-to
-effectively utilize its capabilities. This guide provides detailed information about the project's
-structure, API, and usage, enabling you to navigate the project with ease and unlock its full
-potential.
+to effectively utilize its capabilities. This guide provides detailed information about the
+project's structure, API, and usage, enabling you to navigate the project with ease and unlock its
+full potential.
 
 ### Project Overview
 
 Our project encompasses a suite of modules, each designed to address specific functionalities and
 enhance the overall developer experience. To delve into the intricacies of each module, refer to the
 dedicated documentation pages:
 
-**Dive into the essential components of our project:**
+### API Reference
 
-- **[Stitch](../reference):** Explore the core functionalities that weave everything together,
-  enabling seamless code generation, data binding, and more. Discover how Stitch streamlines your
-  development process and empowers you to focus on your app's core logic.
-
-- **[Codegen](../reference/codegen):** Delve into the heart of code generation, where magic happens
-  behind the scenes. Learn about the mechanisms that transform your annotations and models into
-  efficient, type-safe code, saving you time and effort.
-
-- **[Common](../reference/common):** Explore the shared utilities and components that form the
-  backbone of our project. Discover reusable classes, extensions, and tools that ensure consistency
-  and maintainability across different modules.
-
-- **[Gradle Plugin](../reference/gradle-plugin):** Empower your development with the Kotlin Symbol
-  Processing (KSP) Plugin. Learn how to seamlessly integrate Stitch into your Gradle build process,
-  enabling powerful code generation features at build time.
-
-- **[Gradle Plugin API](../reference/gradle-plugin-api):** Uncover the intricacies of custom Gradle
-  plugin development. Get insights into extending Stitch's capabilities and tailoring it to your
-  specific project needs through a flexible API.
-
-- **[KSP Processor](../reference/ksp):** Dive into the heart of code analysis and transformation.
-  Explore how Stitch utilizes KSP to examine your code, generate tailored components, and weave them
-  seamlessly into your project.
+* [`dev.teogor.stitch`](../html/){:target="_blank"}
+* [`dev.teogor.stitch:codegen`](../html/codegen){:target="_blank"}
+* [`dev.teogor.stitch:common`](../html/common){:target="_blank"}
+* [`dev.teogor.stitch:gradle-plugin`](../html/gradle-plugin){:target="_blank"}
+* [`dev.teogor.stitch:gradle-plugin-api`](../html/gradle-plugi-api){:target="_blank"}
+* [`dev.teogor.stitch:ksp`](../html/ksp){:target="_blank"}
 
 ### Contributions and Support
 

docs/releases.md

@@ -8,16 +8,18 @@ Stitch handles the Room boilerplate, including automatic generation of repositor
 
 ### API Reference
 
-* [`dev.teogor.stitch`](../reference/gradle-plugin)
-* [`dev.teogor.stitch:codegen`](../reference/codegen)
-* [`dev.teogor.stitch:common`](../reference/common)
-* [`dev.teogor.stitch:gradle-plugin-api`](../reference/gradle-plugin-api)
-* [`dev.teogor.stitch:ksp`](../reference/ksp)
+* [`dev.teogor.stitch`](../html/){:target="_blank"}
+* [`dev.teogor.stitch:codegen`](../html/codegen){:target="_blank"}
+* [`dev.teogor.stitch:common`](../html/common){:target="_blank"}
+* [`dev.teogor.stitch:gradle-plugin`](../html/gradle-plugin){:target="_blank"}
+* [`dev.teogor.stitch:gradle-plugin-api`](../html/gradle-plugi-api){:target="_blank"}
+* [`dev.teogor.stitch:ksp`](../html/ksp){:target="_blank"}
 
 ### Release
 
 |   Latest Update   | Stable Release | Beta Release | Alpha Release |
 |:-----------------:|:--------------:|:------------:|:-------------:|
+| February 15, 2024 |       -        |      -       | 1.0.0-alpha02 |
 | February 06, 2024 |       -        |      -       | 1.0.0-alpha01 |
 
 ### Declaring dependencies
@@ -31,15 +33,15 @@ Add the dependencies for the artifacts you need in the `build.gradle` file for y
 
     ```kotlin
     plugins {
-      id("dev.teogor.stitch") version "1.0.0-alpha01"
+      id("dev.teogor.stitch") version "1.0.0-alpha02"
     }
     ```
 
 === "Groovy"
 
     ```groovy
     plugins {
-      id 'dev.teogor.stitch' version '1.0.0-alpha01'
+      id 'dev.teogor.stitch' version '1.0.0-alpha02'
     }
     ```
 
@@ -54,6 +56,23 @@ existing issue by clicking the star button.
 
 ### Version 1.0.0
 
+#### Version 1.0.0-alpha02
+
+February 15, 2024
+
+`dev.teogor.stitch:stitch-*:1.0.0-alpha02` is
+released. [Version 1.0.0-alpha02 contains these commits.](https://github.com/teogor/stitch/compare/1.0.0-alpha01...1.0.0-alpha02)
+
+**Enhancement**
+
+* Introduce Fine-grained Control over Generated Operations ([#8](https://github.com/teogor/stitch/pull/8)) by [@teogor](https://github.com/teogor)
+* Add `:core:database` package for data management ([#5](https://github.com/teogor/stitch/pull/5)) by [@teogor](https://github.com/teogor)
+
+**Bug Fixes**
+
+* Implement `ExplicitEntities` Annotation for Enhanced DAO and Entity Management ([#10](https://github.com/teogor/stitch/pull/10)) by [@teogor](https://github.com/teogor)
+* Prevent unintended null defaults in Stitch code generation ([#6](https://github.com/teogor/stitch/pull/6)) by [@teogor](https://github.com/teogor)
+
 #### Version 1.0.0-alpha01
 
 February 06, 2024

docs/releases/changelog/1.0.0-alpha02.md

@@ -0,0 +1,13 @@
+[//]: # (This file was automatically generated - do not edit)
+
+# Version 1.0.0-alpha02
+
+## Latest SDK versions
+
+| Status |                    Service or Product                     |          Gradle dependency          | Latest version |
+|:------:|:---------------------------------------------------------:|:-----------------------------------:|:--------------:|
+|   🧪   |       [Stitch Codegen](../../../reference/codegen)        |      dev.teogor.stitch:codegen      | 1.0.0-alpha02  |
+|   🧪   |        [Stitch Common](../../../reference/common)         |      dev.teogor.stitch:common       | 1.0.0-alpha02  |
+|   🧪   | [Stitch Plugin API](../../../reference/gradle-plugin-api) | dev.teogor.stitch:gradle-plugin-api | 1.0.0-alpha02  |
+|   🧪   |      [Stitch KSP Processor](../../../reference/ksp)       |        dev.teogor.stitch:ksp        | 1.0.0-alpha02  |
+|   🧪   | [Stitch Gradle Plugin](../../../reference/gradle-plugin)  |          dev.teogor.stitch          | 1.0.0-alpha02  |

docs/releases/implementation.md

@@ -4,14 +4,15 @@
 
 ### Latest Version
 
-The latest release is [`1.0.0-alpha01`](../releases.md)
+The latest release is [`1.0.0-alpha02`](../releases.md)
 
 ### Plugin Releases
 
 Here's a summary of the latest versions:
 
 |    Version    |               Release Notes                | Release Date |
 |:-------------:|:------------------------------------------:|:------------:|
+| 1.0.0-alpha02 | [changelog 🔗](changelog/1.0.0-alpha02.md) | 15 Feb 2024  |
 | 1.0.0-alpha01 | [changelog 🔗](changelog/1.0.0-alpha01.md) | 06 Feb 2024  |
 
 ### Using Version Catalog
@@ -25,34 +26,45 @@ TOML format.
 
     ```toml title="gradle/libs.versions.toml"
     [versions]
-    stitch = "1.0.0-alpha01"
+    teogor-stitch = "1.0.0-alpha02"
 
     [libraries]
-    stitch-common = { id = "dev.teogor.stitch", name = "common", version.ref = "stitch" }
-    stitch-ksp = { id = "dev.teogor.stitch", name = "ksp", version.ref = "stitch" }
+    teogor-stitch-codegen = { module = "dev.teogor.stitch:codegen", version.ref = "teogor-stitch" }
+    teogor-stitch-common = { module = "dev.teogor.stitch:common", version.ref = "teogor-stitch" }
+    teogor-stitch-ksp = { module = "dev.teogor.stitch:ksp", version.ref = "teogor-stitch" }
 
     [plugins]
-    stitch = { id = "dev.teogor.stitch", version.ref = "stitch" }
+    teogor-stitch = { id = "dev.teogor.stitch", version.ref = "teogor-stitch" }
     ```
 
 #### Dependencies Implementation
 
 === "Kotlin"
 
     ```kotlin title="build.gradle.kts"
+    plugins {
+      // Stitch Plugin
+      alias(libs.plugins.teogor.stitch)
+    }
+
     dependencies {
       // Stitch Libraries
-      implementation(libs.stitch.common)
-      ksp(libs.stitch.ksp)
+      implementation(libs.teogor.stitch.common)
+      ksp(libs.teogor.stitch.ksp)
     }
     ```
 
 === "Groovy"
 
     ```groovy title="build.gradle"
+    plugins {
+      // Stitch Plugin
+      alias libs.plugins.teogor.stitch
+    }
+
     dependencies {
       // Stitch Libraries
-      implementation(libs.stitch.common)
-      ksp(libs.stitch.ksp)
+      implementation libs.teogor.stitch.common
+      ksp libs.teogor.stitch.ksp
     }
     ```

mkdocs.yml

@@ -3,7 +3,7 @@ site_description: Stitch handles the Room boilerplate, including automatic gener
 site_author: Teodor Grigor (teogor)
 site_dir: build/docs/stitch
 site_url: https://github.com/teogor/stitch
-edit_uri: raw/main/docs/
+edit_uri: edit/main/docs/
 
 docs_dir: docs