docs: add intro and setup

KakaoCup · Sep 25, 2024 · 1c8781d · 1c8781d
1 parent 80309a1
commit 1c8781d
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 40 deletions.
diff --git a/documentation/docs/intro.md b/documentation/docs/intro.md
@@ -2,49 +2,32 @@
 sidebar_position: 1
 ---
 
-# Setup
+Welcome to **Kakao Compose** tutorial. Let's make UI testing easies and simple. In this documentation we will try to explain functionality of Kakao Compose and
+fundamental concepts of implementation, modules and responsibility of each, how to add this library to your project and
+how to start works on UI test step by step.
 
-Welcome to **Kakao Compose** tutorial. Let's make UI testing easies and simple.
-
-
-## Project structure and libraries
+But before we started, don't forget that `KakaoCup` is fully Open Source and supported by community. 
+Please don't hesitate to contribute to this documentation or fix any bugs. 
+We always welcome to new contributors with any level of codding skills.
 
 ### Overview
 
-### Compose
-
-### Compose Semantics
-
-### Compose UI
-
-### Compose Test
-
-## Getting Started
-
-### Setup project dependencies
-Add those dependencies into your `build.gradle` or `build.gradle.kts` file
-
-:::tip Version
-
-`<latest version>` can be found on project [GitHub](https://github.com/KakaoCup/compose)
-
-:::
-
-```groovy
-dependencies {
-    androidTestImplementation 'io.github.kakaocup:compose:<latest version>'
-}
-```
-
-```kotlin
-dependencies {
-    androidTestImplementation("io.github.kakaocup:compose:<latest version>")
-}
+From version `1.0.0` Kakao Compose contains four main modules, with following dependencies
+
+```mermaid
+flowchart TD
+    Test(compose-test)
+    Compose(compose)
+    UI(compose-ui)
+    Semantics(compose-semantics)
+    Test --> Compose
+    UI --> Semantics
+    Test --> Semantics
 ```
 
-
-:::danger Take care
-
-This action is dangerous
-
-:::
+* `compose` - Core module, which providing DSL wrapping for Espresso methods, 
+Screens page objects and `LazyList` support
+* `compose-semantics` - Set of default semantics keys, what can be used by `compose-ui` and `compose-test` modules
+* `compose-ui` - Wrapped over Compose base components, with the same constructors signatures. 
+Those wrappers will set all possible semantics from `compose-semantics` module, which can be used by `compose-test` module
+* `compose-test` - Providing nodes for typed component validation
diff --git a/documentation/docs/setup.md b/documentation/docs/setup.md
@@ -0,0 +1,24 @@
+---
+sidebar_position: 2
+---
+
+### Setup project dependencies
+Add those dependencies into your `build.gradle` or `build.gradle.kts` file
+
+:::tip Version
+
+`<latest version>` can be found on project [GitHub](https://github.com/KakaoCup/compose)
+
+:::
+
+```groovy
+dependencies {
+    androidTestImplementation 'io.github.kakaocup:compose:<latest version>'
+}
+```
+
+```kotlin
+dependencies {
+    androidTestImplementation("io.github.kakaocup:compose:<latest version>")
+}
+```