Merge pull request #3 from teogor/docs/1.0.0-alpha01

Update documentation for 1.0.0-alpha01 release and remove unwanted changelogs
teogor · Feb 6, 2024 · fd9ac93 · fd9ac93
2 parents 6066c16 + 18fcbbb
commit fd9ac93
Show file tree

Hide file tree

Showing 9 changed files with 68 additions and 174 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -17,7 +17,7 @@ body:
   - type: checkboxes
     attributes:
       label: Is there a StackOverflow question about this issue?
-      description: Please search [StackOverflow](https://stackoverflow.com/questions/tagged/winds) if an issue with an answer already exists for the bug you encountered.
+      description: Please search [StackOverflow](https://stackoverflow.com/questions/tagged/stitch) if an issue with an answer already exists for the bug you encountered.
       options:
         - label: I have searched StackOverflow
           required: true

diff --git a/docs/reference.md b/docs/reference.md
@@ -9,28 +9,41 @@ 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:
+enhance the overall developer experience. To delve into the intricacies of each module, refer to the
+dedicated documentation pages:
 
-- **[Winds 🔗](../reference):** Discover the heart of our project.
+**Dive into the essential components of our project:**
 
-- **[API 🔗](../reference/api):** Navigate directly to the code-specific documentation for the
-  project's `:api` module
+- **[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.
 
-- **[Common 🔗](../reference/common):** Navigate directly to the code-specific documentation for the
-  project's `:common` module
+- **[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.
 
-- **[Plugin 🔗](../reference/gradle-plugin):** Navigate directly to the code-specific documentation
-  for the project's `:gradle-plugin` module
+- **[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.
 
 ### Contributions and Support
 
 We welcome your valuable feedback and contributions to the project. Your insights are crucial for
 shaping the project's future and ensuring it continues to meet the needs of our community. If you
 encounter any issues or have questions, please feel free to raise them on
-the [GitHub Issues 🔗](https://github.com/teogor/winds/issues) page. Our team is dedicated to
+the [GitHub Issues 🔗](https://github.com/teogor/stitch/issues) page. Our team is dedicated to
 assisting you and continuously improving the project's overall quality.
 
 ### Embark on Your Coding Journey

diff --git a/docs/releases.md b/docs/releases.md
@@ -1,26 +1,28 @@
 [//]: # (This file was automatically generated - do not edit)
 
-# Winds
+# Stitch
 
-Winds build and publish libraries and applications for multiple platforms, simple and efficient.
+Stitch handles the Room boilerplate, including automatic generation of repositories, dependency injection integration, and flexible customizations.
 
 ---
 
 ### API Reference
 
-* [`dev.teogor.winds`](../reference/gradle-plugin)
-* [`dev.teogor.winds:api`](../reference/api)
-* [`dev.teogor.winds:common`](../reference/common)
+* [`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)
 
 ### Release
 
 |   Latest Update   | Stable Release | Beta Release | Alpha Release |
 |:-----------------:|:--------------:|:------------:|:-------------:|
-| November 24, 2023 |       -        |      -       | 1.0.0-alpha04 |
+| February 06, 2024 |       -        |      -       | 1.0.0-alpha01 |
 
 ### Declaring dependencies
 
-To add a dependency on Winds, you must add the Maven repository to your project.
+To add a dependency on Stitch, you must add the Maven repository to your project.
 Read [Maven's repository for more information](https://repo.maven.apache.org/maven2/).
 
 Add the dependencies for the artifacts you need in the `build.gradle` file for your app or module:
@@ -29,116 +31,34 @@ Add the dependencies for the artifacts you need in the `build.gradle` file for y
 
     ```kotlin
     plugins {
-      id("dev.teogor.winds") version "1.0.0-alpha04"
+      id("dev.teogor.stitch") version "1.0.0-alpha01"
     }
     ```
 
 === "Groovy"
 
     ```groovy
     plugins {
-      id 'dev.teogor.winds' version '1.0.0-alpha04'
+      id 'dev.teogor.stitch' version '1.0.0-alpha01'
     }
     ```
 
 ### Feedback
 
-Your feedback helps make Winds better. We want to know if you discover new issues or have ideas
+Your feedback helps make Stitch better. We want to know if you discover new issues or have ideas
 for improving this library. Before creating a new issue, please take a look at
-the [existing ones](https://github.com/teogor/winds) in this library. You can add your vote to an
+the [existing ones](https://github.com/teogor/stitch) in this library. You can add your vote to an
 existing issue by clicking the star button.
 
-[Create a new issue](https://github.com/teogor/winds/issues/new){ .md-button }
+[Create a new issue](https://github.com/teogor/stitch/issues/new){ .md-button }
 
 ### Version 1.0.0
 
-#### Version 1.0.0-alpha04
-
-November 24, 2023
-
-`dev.teogor.winds:winds-*:1.0.0-alpha04` is
-released. [Version 1.0.0-alpha04 contains these commits.](https://github.com/teogor/winds/compare/1.0.0-alpha03...1.0.0-alpha04)
-
-**Enhancement**
-
-* Introduce ProjectPluginUtils for Managing Project Plugins ([#34](https://github.com/teogor/winds/pull/34)) by [@teogor](https://github.com/teogor)
-* Refined Docs Generator Task for Streamlined Documentation ([#35](https://github.com/teogor/winds/pull/35)) by [@teogor](https://github.com/teogor)
-
-**Bug Fixes**
-
-* Fixed the Flow of BoM Dependency Collection ([#37](https://github.com/teogor/winds/pull/37)) by [@teogor](https://github.com/teogor)
-* Introduce processWindsChildProjects for Streamlined Child Project Processing ([#36](https://github.com/teogor/winds/pull/36)) by [@teogor](https://github.com/teogor)
-* Correct file and directory creation logic in BaseGeneratorTask ([#33](https://github.com/teogor/winds/pull/33)) by [@teogor](https://github.com/teogor)
-
-#### Version 1.0.0-alpha03
-
-November 20, 2023
-
-`dev.teogor.winds:winds-*:1.0.0-alpha03` is
-released. [Version 1.0.0-alpha03 contains these commits.](https://github.com/teogor/winds/compare/1.0.0-alpha02...1.0.0-alpha03)
-
-**Enhancement**
-
-* Enhance version handling and introduce new version
-  structure ([#26](https://github.com/teogor/winds/pull/26)) by [@teogor](https://github.com/teogor)
-* Dependency Management with Flexible Gathering and
-  Filtering ([#25](https://github.com/teogor/winds/pull/25)) by [@teogor](https://github.com/teogor)
-* Add BoM constraints for subprojects ([#22](https://github.com/teogor/winds/pull/22))
-  by [@teogor](https://github.com/teogor)
-
-**Bug Fixes**
-
-* Module documentation for android with improved grouping and
-  filtering ([#27](https://github.com/teogor/winds/pull/27)) by [@teogor](https://github.com/teogor)
-* Address Missing Developer Information in PoM ([#24](https://github.com/teogor/winds/pull/24))
-  by [@teogor](https://github.com/teogor)
-* Fix missing license in PoM ([#23](https://github.com/teogor/winds/pull/23))
-  by [@teogor](https://github.com/teogor)
-* Add BoM constraints for subprojects ([#22](https://github.com/teogor/winds/pull/22))
-  by [@teogor](https://github.com/teogor)
-
-**Others**
-
-* Enrich Action Workflow with Accurate Publish
-  Commands ([#30](https://github.com/teogor/winds/pull/30)) by [@teogor](https://github.com/teogor)
-* Centralize Group and Version for Improved Subproject
-  Management ([#29](https://github.com/teogor/winds/pull/29))
-  by [@teogor](https://github.com/teogor)
-* Fixed wrong api version ([#20](https://github.com/teogor/winds/pull/20))
-  by [@teogor](https://github.com/teogor)
-
-#### Version 1.0.0-alpha02
-
-November 08, 2023
-
-`dev.teogor.winds:winds-*:1.0.0-alpha02` is
-released. [Version 1.0.0-alpha02 contains these commits.](https://github.com/teogor/winds/compare/1.0.0-alpha01...1.0.0-alpha02)
-
-**Enhancement**
-
-* Dependency Representation, Alert for Local Project
-  Dependencies ([#16](https://github.com/teogor/winds/pull/16))
-  by [@teogor](https://github.com/teogor)
-* Improved BoM Configuration and Function Naming ([#10](https://github.com/teogor/winds/pull/10))
-  by [@teogor](https://github.com/teogor)
-
-**Bug Fixes**
-
-* Enhanced Winds Plugin Support with Project Extension and Module Information
-  Retrieval ([#17](https://github.com/teogor/winds/pull/17)) by [@teogor](https://github.com/teogor)
-* Handle Resolution of Empty Dependencies in Project
-  Configuration ([#15](https://github.com/teogor/winds/pull/15))
-  by [@teogor](https://github.com/teogor)
-* Resolve Misconfigured Modules Using kotlin-dsl ([#13](https://github.com/teogor/winds/pull/13))
-  by [@teogor](https://github.com/teogor)
-* Added Javadoc for Developer Interface Properties and Introduced Email
-  Field ([#8](https://github.com/teogor/winds/pull/8)) by [@teogor](https://github.com/teogor)
-
 #### Version 1.0.0-alpha01
 
-November 03, 2023
+February 06, 2024
 
-`dev.teogor.winds:winds-*:1.0.0-alpha01` is
-released. [Version 1.0.0-alpha01 contains these commits.](https://github.com/teogor/winds/compare/db0013be686149f05638accd534dab2fb81a8818...1.0.0-alpha01)
+`dev.teogor.stitch:stitch-*:1.0.0-alpha01` is
+released. [Version 1.0.0-alpha01 contains these commits.](https://github.com/teogor/stitch/compare/43cf9e9901d0b0f535761247c3869207a87e4016...1.0.0-alpha01)
 
 **Initial Release** 🎊
diff --git a/docs/releases/changelog/1.0.0-alpha01.md b/docs/releases/changelog/1.0.0-alpha01.md
@@ -4,8 +4,10 @@
 
 ## Latest SDK versions
 
-| Status |                Service or Product                |       Gradle dependency       | Latest version |
-|:------:|:------------------------------------------------:|:-----------------------------:|:--------------:|
-|   🧪   |       [Winds API](../../../reference/api)        |  dev.teogor.winds:winds-api   | 1.0.0-alpha01  |
-|   🧪   |    [Winds Common](../../../reference/common)     | dev.teogor.winds:winds-common | 1.0.0-alpha01  |
-|   🧪   | [Winds Plugin](../../../reference/gradle-plugin) |       dev.teogor.winds        | 1.0.0-alpha01  |
+| Status |                    Service or Product                     |          Gradle dependency          | Latest version |
+|:------:|:---------------------------------------------------------:|:-----------------------------------:|:--------------:|
+|   🧪   |       [Stitch Codegen](../../../reference/codegen)        |      dev.teogor.stitch:codegen      | 1.0.0-alpha01  |
+|   🧪   |        [Stitch Common](../../../reference/common)         |      dev.teogor.stitch:common       | 1.0.0-alpha01  |
+|   🧪   | [Stitch Plugin API](../../../reference/gradle-plugin-api) | dev.teogor.stitch:gradle-plugin-api | 1.0.0-alpha01  |
+|   🧪   |      [Stitch KSP Processor](../../../reference/ksp)       |        dev.teogor.stitch:ksp        | 1.0.0-alpha01  |
+|   🧪   | [Stitch Gradle Plugin](../../../reference/gradle-plugin)  |          dev.teogor.stitch          | 1.0.0-alpha01  |
diff --git a/docs/releases/changelog/1.0.0-alpha02.md b/docs/releases/changelog/1.0.0-alpha02.md
diff --git a/docs/releases/changelog/1.0.0-alpha03.md b/docs/releases/changelog/1.0.0-alpha03.md
diff --git a/docs/releases/changelog/1.0.0-alpha04.md b/docs/releases/changelog/1.0.0-alpha04.md
diff --git a/docs/releases/implementation.md b/docs/releases/implementation.md
@@ -4,45 +4,35 @@
 
 ### Latest Version
 
-The latest release is [`1.0.0-alpha04`](../releases.md)
+The latest release is [`1.0.0-alpha01`](../releases.md)
 
 ### Plugin Releases
 
 Here's a summary of the latest versions:
 
 |    Version    |               Release Notes                | Release Date |
 |:-------------:|:------------------------------------------:|:------------:|
-| 1.0.0-alpha04 | [changelog 🔗](changelog/1.0.0-alpha04.md) | 24 Nov 2023  |
-| 1.0.0-alpha03 | [changelog 🔗](changelog/1.0.0-alpha03.md) | 20 Nov 2023  |
-| 1.0.0-alpha02 | [changelog 🔗](changelog/1.0.0-alpha02.md) | 08 Nov 2023  |
-| 1.0.0-alpha01 | [changelog 🔗](changelog/1.0.0-alpha01.md) | 03 Nov 2023  |
+| 1.0.0-alpha01 | [changelog 🔗](changelog/1.0.0-alpha01.md) | 06 Feb 2024  |
 
 ### Using Version Catalog
 
 #### Declare Components
 
-This catalog provides the implementation details of Winds libraries and individual libraries, in
+This catalog provides the implementation details of Stitch libraries and individual libraries, in
 TOML format.
 
 === "Default"
 
     ```toml title="gradle/libs.versions.toml"
     [versions]
-    winds = "1.0.0-alpha04"
-
-    [plugins]
-    winds = { id = "dev.teogor.winds", version.ref = "winds" }
-    ```
-
-=== "Using Plugin SDK"
-
-    ```toml title="gradle/libs.versions.toml"
-    [versions]
-    winds = "1.0.0-alpha04"
+    stitch = "1.0.0-alpha01"
 
     [libraries]
-    winds-api = { group = "dev.teogor.winds", name = "api", version.ref = "winds" }
-    winds-common = { group = "dev.teogor.winds", name = "common", version.ref = "winds" }
+    stitch-common = { id = "dev.teogor.stitch", name = "common", version.ref = "stitch" }
+    stitch-ksp = { id = "dev.teogor.stitch", name = "ksp", version.ref = "stitch" }
+
+    [plugins]
+    stitch = { id = "dev.teogor.stitch", version.ref = "stitch" }
     ```
 
 #### Dependencies Implementation
@@ -51,18 +41,18 @@ TOML format.
 
     ```kotlin title="build.gradle.kts"
     dependencies {
-      // Winds Libraries
-      implementation(libs.winds.api)
-      implementation(libs.winds.common)
+      // Stitch Libraries
+      implementation(libs.stitch.common)
+      ksp(libs.stitch.ksp)
     }
     ```
 
 === "Groovy"
 
     ```groovy title="build.gradle"
     dependencies {
-      // Winds Libraries
-      implementation(libs.winds.api)
-      implementation(libs.winds.common)
+      // Stitch Libraries
+      implementation(libs.stitch.common)
+      ksp(libs.stitch.ksp)
     }
     ```
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,5 +1,5 @@
 site_name: Stitch
-site_description: Winds build and publish libraries and applications for multiple platforms, simple and efficient.
+site_description: Stitch handles the Room boilerplate, including automatic generation of repositories, dependency injection integration, and flexible customizations.
 site_author: Teodor Grigor (teogor)
 site_dir: build/docs/stitch
 site_url: https://github.com/teogor/stitch
@@ -20,6 +20,8 @@ nav:
   - Releases:
     - releases.md
     - Implementation: releases/implementation.md
+    - Changelog:
+        - 1.0.0-alpha01: releases/changelog/1.0.0-alpha01.md
   - Reference: reference.md
   - Sponsor: sponsor.md
   - Security: security.md