From ae17e085888e8b46a5e7ec6ce90bd8b603e37bb2 Mon Sep 17 00:00:00 2001
From: i-walker <46971368+i-walker@users.noreply.github.com>
Date: Thu, 10 Mar 2022 09:11:22 +0100
Subject: [PATCH 1/2] update docs
---
arrow-site/docs/docs/quickstart/README.md | 101 +---------------------
1 file changed, 4 insertions(+), 97 deletions(-)
diff --git a/arrow-site/docs/docs/quickstart/README.md b/arrow-site/docs/docs/quickstart/README.md
index 1a631c8a981..3d8d79316e7 100644
--- a/arrow-site/docs/docs/quickstart/README.md
+++ b/arrow-site/docs/docs/quickstart/README.md
@@ -182,20 +182,7 @@ dependencies {
#### Next development version
-If you want to try the latest features, replace `1.0.1` with `1.0.2-SNAPSHOT` and add this
-configuration:
-
-```
-allprojects {
- repositories {
- ...
- maven(url = "https://oss.sonatype.org/content/repositories/snapshots/")
- }
-
- // To use latest artifacts
- configurations.all { resolutionStrategy.cacheChangingModulesFor(0, "seconds") }
-}
-```
+If you want to try the latest features, replace `1.0.1` with the latest `alpha` release.
@@ -262,20 +249,7 @@ dependencies {
#### Next development version
-If you want to try the latest features, replace `1.0.1` with `1.0.2-SNAPSHOT` and add this
-configuration:
-
-```groovy
-allprojects {
- repositories {
- ...
- maven { url "https://oss.sonatype.org/content/repositories/snapshots/" }
- }
-
- // To use latest artifacts
- configurations.all { resolutionStrategy.cacheChangingModulesFor 0, 'seconds' }
-}
-```
+If you want to try the latest features, replace `1.0.1` with the latest `alpha` release.
@@ -289,7 +263,7 @@ following properties:
```xml
- 1.5.31
+ 1.6.10
1.0.1
```
@@ -305,58 +279,6 @@ Add the dependencies that you want to use:
```
-#### Enabling kapt for the Optics DSL
-
-For the Optics DSL, enable annotation processing using Kotlin plugin:
-
-```xml
-
-
- org.jetbrains.kotlin
- kotlin-maven-plugin
- ${kotlin.version}
-
-
- kapt
-
- kapt
-
-
-
- src/main/kotlin
-
-
-
- io.arrow-kt
- arrow-meta
- ${arrow.version}
-
-
-
-
-
- compile
- compile
-
- compile
-
-
-
- src/main/kotlin
-
-
-
-
- test-compile
- test-compile
-
- test-compile
-
-
-
-
-```
-
#### BOM file
To avoid specifying the Arrow version for every dependency, a BOM file is available:
@@ -380,23 +302,8 @@ To avoid specifying the Arrow version for every dependency, a BOM file is availa
#### Next development version
-If you want to try the latest features, replace `1.0.1` with `1.0.2-SNAPSHOT` and add this
-configuration:
-
-```xml
-
-
-
- https://oss.sonatype.org/content/repositories/snapshots/
- always
-
-
-```
-
+If you want to try the latest features, replace `1.0.1` with the latest `alpha` release.
-
-
-
From 93674e6bea3d9c7baa66dd71b1028bb862c28e28 Mon Sep 17 00:00:00 2001
From: i-walker <46971368+i-walker@users.noreply.github.com>
Date: Thu, 10 Mar 2022 10:08:38 +0100
Subject: [PATCH 2/2] update docs
---
arrow-site/docs/docs/core/README.md | 4 +-
arrow-site/docs/docs/fx/README.md | 95 +----------------------
arrow-site/docs/docs/optics/README.md | 4 +-
arrow-site/docs/docs/quickstart/README.md | 21 ++---
4 files changed, 20 insertions(+), 104 deletions(-)
diff --git a/arrow-site/docs/docs/core/README.md b/arrow-site/docs/docs/core/README.md
index 366d8377ff5..293f33a97b2 100644
--- a/arrow-site/docs/docs/core/README.md
+++ b/arrow-site/docs/docs/core/README.md
@@ -183,7 +183,7 @@ dependencies {
#### Next development version
-If you want to try the latest features, replace `1.0.1` with on of the latest `alpha`, `beta` or `rc` publications.
+If you want to try the latest features, replace `1.0.1` with one of the latest `alpha`, `beta` or `rc` publications.
@@ -236,7 +236,7 @@ To avoid specifying the Arrow version for every dependency, a BOM file is availa
#### Next development version
-If you want to try the latest features, replace `1.0.1` with on of the latest `alpha`, `beta` or `rc` publications.
+If you want to try the latest features, replace `1.0.1` with one of the latest `alpha`, `beta` or `rc` publications.
diff --git a/arrow-site/docs/docs/fx/README.md b/arrow-site/docs/docs/fx/README.md
index daba11bc2a2..d0237c6d934 100644
--- a/arrow-site/docs/docs/fx/README.md
+++ b/arrow-site/docs/docs/fx/README.md
@@ -139,19 +139,7 @@ dependencies {
#### Next development version
-If you want to try the latest features, replace `1.0.1` with `1.0.2-SNAPSHOT` and add this
-configuration:
-
-```
-allprojects {
- repositories {
- maven(url = "https://oss.sonatype.org/content/repositories/snapshots/")
- }
-
- // To use latest artifacts
- configurations.all { resolutionStrategy.cacheChangingModulesFor(0, "seconds") }
-}
-```
+If you want to try the latest features, replace `1.0.1` with one of the latest `alpha`, `beta` or `rc` publications.
@@ -195,19 +183,7 @@ dependencies {
#### Next development version
-If you want to try the latest features, replace `1.0.1` with `1.0.2-SNAPSHOT` and add this
-configuration:
-
-```groovy
-allprojects {
- repositories {
- maven { url "https://oss.sonatype.org/content/repositories/snapshots/" }
- }
-
- // To use latest artifacts
- configurations.all { resolutionStrategy.cacheChangingModulesFor 0, 'seconds' }
-}
-```
+If you want to try the latest features, replace `1.0.1` with one of the latest `alpha`, `beta` or `rc` publications.
@@ -220,7 +196,7 @@ following properties:
```xml
- 1.5.31
+ 1.6.10
1.0.1
```
@@ -236,58 +212,6 @@ Add the dependencies that you want to use:
```
-#### Enabling kapt for the Optics DSL
-
-For the Optics DSL, enable annotation processing using Kotlin plugin:
-
-```xml
-
-
- org.jetbrains.kotlin
- kotlin-maven-plugin
- ${kotlin.version}
-
-
- kapt
-
- kapt
-
-
-
- src/main/kotlin
-
-
-
- io.arrow-kt
- arrow-meta
- ${arrow.version}
-
-
-
-
-
- compile
- compile
-
- compile
-
-
-
- src/main/kotlin
-
-
-
-
- test-compile
- test-compile
-
- test-compile
-
-
-
-
-```
-
#### BOM file
To avoid specifying the Arrow version for every dependency, a BOM file is available:
@@ -311,18 +235,7 @@ To avoid specifying the Arrow version for every dependency, a BOM file is availa
#### Next development version
-If you want to try the latest features, replace `1.0.1` with `1.0.2-SNAPSHOT` and add this
-configuration:
-
-```xml
-
-
-
- https://oss.sonatype.org/content/repositories/snapshots/
- always
-
-
-```
+If you want to try the latest features, replace `1.0.1` with one of the latest `alpha`, `beta` or `rc` publications.
diff --git a/arrow-site/docs/docs/optics/README.md b/arrow-site/docs/docs/optics/README.md
index 17e9fabc170..5fdd94cfc3a 100644
--- a/arrow-site/docs/docs/optics/README.md
+++ b/arrow-site/docs/docs/optics/README.md
@@ -154,7 +154,7 @@ To get the most of Arrow Optics you can add out Kotlin plug-in to your build, wh
```
plugins {
- id("com.google.devtools.ksp") version "1.6.0-1.0.2"
+ id("com.google.devtools.ksp") version "1.6.10-1.0.4"
}
dependencies {
@@ -214,7 +214,7 @@ To get the most of Arrow Optics you can add out Kotlin plug-in to your build, wh
```groovy
plugins {
- id "com.google.devtools.ksp" version "1.6.0-1.0.2"
+ id "com.google.devtools.ksp" version "1.6.10-1.0.4"
}
dependencies {
diff --git a/arrow-site/docs/docs/quickstart/README.md b/arrow-site/docs/docs/quickstart/README.md
index 3d8d79316e7..478fd4e60ed 100644
--- a/arrow-site/docs/docs/quickstart/README.md
+++ b/arrow-site/docs/docs/quickstart/README.md
@@ -129,7 +129,7 @@ Arrow supports Android starting on API 21 and up.
In your project's root `build.gradle.kts`, append this repository to your list:
-```
+```kotlin
allprojects {
repositories {
mavenCentral()
@@ -141,7 +141,7 @@ Add the dependencies into the project's `build.gradle.kts`:
##### Arrow Core
-```
+```kotlin
dependencies {
implementation("io.arrow-kt:arrow-core:1.0.1")
}
@@ -150,14 +150,16 @@ dependencies {
##### Arrow Core + Arrow Optics
```
-apply plugin: 'kotlin-kapt'
+apply plugin: 'com.google.devtools.ksp'
dependencies {
implementation("io.arrow-kt:arrow-optics:1.0.1")
- kapt("io.arrow-kt:arrow-meta:1.0.1")
+ ksp("io.arrow-kt:arrow-optics-ksp-plugin:$arrowVersion")
}
```
+here is an example repository https://github.com/arrow-kt/Arrow-JVM-Template/tree/optics-setup.
+
##### Arrow Core + Arrow Fx
```
@@ -214,15 +216,16 @@ dependencies {
##### Arrow Core + Arrow Optics
```groovy
-apply plugin: 'kotlin-kapt'
+apply plugin: 'com.google.devtools.ksp'
-def arrow_version = "1.0.1"
dependencies {
- implementation "io.arrow-kt:arrow-optics:$arrow_version"
- kapt "io.arrow-kt:arrow-meta:$arrow_version"
+ implementation "io.arrow-kt:arrow-optics:1.0.1"
+ ksp "io.arrow-kt:arrow-optics-ksp-plugin:$arrowVersion"
}
```
+here is an example repository https://github.com/arrow-kt/Arrow-JVM-Template/tree/optics-setup.
+
##### Arrow Core + Arrow Fx
```groovy
@@ -295,7 +298,7 @@ To avoid specifying the Arrow version for every dependency, a BOM file is availa
import
-
+
...
```