diff --git a/README.md b/README.md index b5825283e..99673ea57 100644 --- a/README.md +++ b/README.md @@ -194,7 +194,6 @@ Here's additional documentation for learning more about this project: - [Versioning strategy](documentation/versioning-strategy.md) - [Declarations lifecycle](documentation/declarations-lifecycle.md) - [Security Policy](SECURITY.md) -- [Roadmap](documentation/roadmap.md) ## Community diff --git a/documentation/roadmap.md b/documentation/roadmap.md deleted file mode 100644 index 03cd22f4a..000000000 --- a/documentation/roadmap.md +++ /dev/null @@ -1,133 +0,0 @@ - - -# Roadmap - -The goal of this roadmap is to give you a big picture about what is coming for -Kotools Types. - -Here’s a list of the most important things we focus on delivering: - -- **Aligning factory functions with Java & Kotlin standards** by - conventionalizing their naming and by representing possible failures with the - `null` expression (discussion [#315]). -- **Clearing separation between the experimental API and the stable API** by - centralizing experimental declarations in the `kotools.types.experimental` - package (issue [#319]). - -## Version 4.3.2 - -### General - -- Documentation of the versioning strategy (issue [#215]). -- Documentation of the declarations lifecycle (issue [#307]). - -### Experimental API - -- New `ExperimentalKotoolsTypesApi` annotation (issue [#191]). -- Deletion of factory functions suffixed by `OrNull` and `OrThrow` for all - types (issue [#258]). -- Moving experimental declarations to the `kotools.types.experimental` package - (issue [#319]). - -See the [corresponding milestone][milestone-4.3.2] for more details. - -## Version 4.3.3 - -### Experimental API - -- Deletion of `Result.flatMap` function (issue [#125]). -- New factory functions named `create*` for all types (issue [#316]). -- New equality operations for the `Bound` type (issue [#223]). -- New equality operations for the `NotEmptyRange` type (issue [#225]). -- New type converters on `AnyInt` to [Byte][kotlin.byte], - [Short][kotlin.short], [Long][kotlin.long], [Float][kotlin.float] and - [Double][kotlin.double] (issue [#320]). - -See the [corresponding milestone][milestone-4.3.3] for more details. - -## Version 4.4.0 - -### Stable API - -- Stabilization of factory functions named `create*` (issue [#321]). -- Deprecation of factory functions using [Result][kotlin.result] (issue - [#263]). -- Deprecation of the `ResultContext` type and its declarations (issue [#264]). - -### Experimental API - -- Deprecation of annotations in the `kotools.types.experimental` package, except - the `ExperimentalKotoolsTypesApi` annotation (issue [#327]). - -See the [corresponding milestone][milestone-4.4.0] for more details. - -## Version 5.0.0 - -### General - -- Support [Kotlin 1.8.10][kotlin-1.8.10] (issue [#172]). -- Hiding internals from Java (issue [#303]). - -### Stable API - -- Deletion of factory functions using [Result][kotlin.result] (issue [#267]). -- Deletion of the `ResultContext` type and its declarations (issue [#270]). - -### Experimental API - -- Deletion of deprecated annotations in the `kotools.types.experimental` - package (issue [#318]). - -See the [corresponding milestone][milestone-5.0.0] for more details. - -## Discussing - -- Stabilization of concatenations for the `NotBlankString` type. -- Stabilization of the `Bound` and the `NotEmptyRange` types. -- New `ZeroDouble`, `StrictlyNegativeDouble`, `PositiveDouble`, `NonZeroDouble`, - `NegativeDouble` and `AnyDouble` types. -- Converting collections to normal classes (because value classes are only - useful for holding primitives). -- Converting extension functions to member functions. -- Support [Kotlin 1.8.22][kotlin-1.8.22]. -- Support [Kotlin 1.9.10][kotlin-1.9.10]. - -[#125]: https://github.com/kotools/types/issues/125 -[#172]: https://github.com/kotools/types/issues/172 -[#191]: https://github.com/kotools/types/issues/191 -[#215]: https://github.com/kotools/types/issues/215 -[#223]: https://github.com/kotools/types/issues/223 -[#225]: https://github.com/kotools/types/issues/225 -[#258]: https://github.com/kotools/types/issues/258 -[#263]: https://github.com/kotools/types/issues/263 -[#264]: https://github.com/kotools/types/issues/264 -[#267]: https://github.com/kotools/types/issues/267 -[#270]: https://github.com/kotools/types/issues/270 -[#303]: https://github.com/kotools/types/issues/303 -[#307]: https://github.com/kotools/types/issues/307 -[#312]: https://github.com/kotools/types/issues/312 -[#315]: https://github.com/kotools/types/discussions/315 -[#316]: https://github.com/kotools/types/issues/316 -[#318]: https://github.com/kotools/types/issues/318 -[#319]: https://github.com/kotools/types/issues/319 -[#320]: https://github.com/kotools/types/issues/320 -[#321]: https://github.com/kotools/types/issues/321 -[#327]: https://github.com/kotools/types/issues/327 -[api-reference]: https://types.kotools.org -[kotlin-1.8.10]: https://github.com/JetBrains/kotlin/releases/tag/v1.8.10 -[kotlin-1.8.22]: https://github.com/JetBrains/kotlin/releases/tag/v1.8.22 -[kotlin-1.9.10]: https://github.com/JetBrains/kotlin/releases/tag/v1.9.10 -[kotlin.byte]: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte -[kotlin.double]: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double -[kotlin.float]: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float -[kotlin.long]: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long -[kotlin.result]: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-result -[kotlin.short]: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short -[milestone-4.3.2]: https://github.com/kotools/types/milestone/22 -[milestone-4.3.3]: https://github.com/kotools/types/milestone/29 -[milestone-4.4.0]: https://github.com/kotools/types/milestone/7 -[milestone-5.0.0]: https://github.com/kotools/types/milestone/27 -[semantic-versioning]: https://semver.org