Update README and documentation, bump dataframe version

Reorganized README, moving version compatibility table and adding more links in the documentation section. Updated documentation for `readSqlDatabases.md`, including a note about the database support limitations. Updated dataframe version in `libs.versions.toml` from `0.12.0` to `0.12.1`. Edited phrasing in `RELEASE_CHECK_LIST.md` and `overview.md`.

Author: zaleslaw

README.md

@@ -20,8 +20,21 @@ Kotlin Dataframe aims to reconcile Kotlin's static typing with the dynamic natur
 
 Integrates with [Kotlin kernel for Jupyter](https://github.com/Kotlin/kotlin-jupyter). Inspired by [krangl](https://github.com/holgerbrandl/krangl), Kotlin Collections and [pandas](https://pandas.pydata.org/)
 
+## Documentation
+
 Explore [**documentation**](https://kotlin.github.io/dataframe/overview.html) for details.
 
+You could find the following articles there:
+
+* [Get started with Kotlin DataFrame](https://kotlin.github.io/dataframe/gettingstarted.html)
+* [Working with Data Schemas](https://kotlin.github.io/dataframe/schemas.html)
+* [Full list of all supported operations](https://kotlin.github.io/dataframe/operations.html)
+    * [Reading from SQL databases](https://kotlin.github.io/dataframe/readsqldatabases.html)
+    * [Reading/writing from/to different file formats like JSON, CSV, Apache Arrow](https://kotlin.github.io/dataframe/read.html)
+    * [Joining a few dataframes](https://kotlin.github.io/dataframe/join.html)
+    * [GroupBy operation](https://kotlin.github.io/dataframe/groupby.html)
+* [Rendering to HTML](https://kotlin.github.io/dataframe/tohtml.html#jupyter-notebooks)
+
 ## Setup
 
 ### Gradle for JVM
@@ -180,20 +193,6 @@ or specific version:
   * `ColumnGroup` — contains columns
   * `FrameColumn` — contains dataframes
 
-
-## Kotlin, Kotlin Jupyter, OpenAPI, Arrow and JDK versions
-
-This table shows the mapping between main library component versions and minimum supported Java versions.
-
-| Kotlin DataFrame Version | Minimum Java Version | Kotlin Version | Kotlin Jupyter Version | OpenAPI version | Apache Arrow version |
-|--------------------------|----------------------|----------------|------------------------|-----------------|----------------------|
-| 0.10.0                   | 8                    | 1.8.20         | 0.11.0-358             | 3.0.0           | 11.0.0               |
-| 0.10.1                   | 8                    | 1.8.20         | 0.11.0-358             | 3.0.0           | 11.0.0               |
-| 0.11.0                   | 8                    | 1.8.20         | 0.11.0-358             | 3.0.0           | 11.0.0               |
-| 0.11.1                   | 8                    | 1.8.20         | 0.11.0-358             | 3.0.0           | 11.0.0               |
-| 0.12.0                   | 8                    | 1.9.0          | 0.11.0-358             | 3.0.0           | 11.0.0               |
-| 0.12.1                   | 8                    | 1.9.0          | 0.11.0-358             | 3.0.0           | 11.0.0               |
-
 ## Usage example
 
 **Create:**
@@ -272,6 +271,20 @@ clean
 
 [Try it in **Datalore**](https://datalore.jetbrains.com/view/notebook/vq5j45KWkYiSQnACA2Ymij) and explore [**more examples here**](examples).
 
+## Kotlin, Kotlin Jupyter, OpenAPI, Arrow and JDK versions
+
+This table shows the mapping between main library component versions and minimum supported Java versions.
+
+| Kotlin DataFrame Version | Minimum Java Version | Kotlin Version | Kotlin Jupyter Version | OpenAPI version | Apache Arrow version |
+|--------------------------|----------------------|----------------|------------------------|-----------------|----------------------|
+| 0.10.0                   | 8                    | 1.8.20         | 0.11.0-358             | 3.0.0           | 11.0.0               |
+| 0.10.1                   | 8                    | 1.8.20         | 0.11.0-358             | 3.0.0           | 11.0.0               |
+| 0.11.0                   | 8                    | 1.8.20         | 0.11.0-358             | 3.0.0           | 11.0.0               |
+| 0.11.1                   | 8                    | 1.8.20         | 0.11.0-358             | 3.0.0           | 11.0.0               |
+| 0.12.0                   | 8                    | 1.9.0          | 0.11.0-358             | 3.0.0           | 11.0.0               |
+| 0.12.1                   | 8                    | 1.9.0          | 0.11.0-358             | 3.0.0           | 11.0.0               |
+
+
 ## Code of Conduct
 
 This project and the corresponding community are governed by the [JetBrains Open Source and Community Code of Conduct](https://confluence.jetbrains.com/display/ALL/JetBrains+Open+Source+and+Community+Code+of+Conduct). Please make sure you read it.

RELEASE_CHECK_LIST.md

@@ -33,4 +33,4 @@
     - `Level.WARNING` messages are changed to `Level.ERROR`
     - `Level.ERROR` messages and their functions are removed.
     - Update regions in the file accordingly.
-20. Update Notebook examples, both in the project as well as on Datalore.
+20. Update Notebook examples, both in the project and on Datalore.

docs/StardustDocs/topics/overview.md

@@ -20,7 +20,8 @@ The goal of data wrangling is to assure quality and useful data.
 
 ## Main Features and Concepts
 
-* [**Hierarchical**](hierarchical.md) — the Kotlin DataFrame library provides an ability to read and present data from different sources including not only plain **CSV** but also **JSON**. That’s why it has been designed hierarchical and allows nesting of columns and cells.
+* [**Hierarchical**](hierarchical.md) — the Kotlin DataFrame library provides an ability to read and present data from different sources including not only plain **CSV** but also **JSON** or **[SQL databases](readSqlDatabases.md)**.
+That’s why it has been designed hierarchical and allows nesting of columns and cells.
 
 * [**Interoperable**](collectionsInterop.md) — hierarchical data layout also opens a possibility of converting any objects 
 structure in application memory to a data frame and vice versa.

docs/StardustDocs/topics/readSqlDatabases.md

@@ -14,6 +14,12 @@ There are two main blocks of available functionality:
   * ```getSchemaForResultSet``` for rows reading through the given ResultSet
   * ```getSchemaForAllSqlTables``` for all non-system tables
 
+**NOTE:** This is an experimental module and for now, 
+we only support four databases: MariaDB, MySQL, PostgreSQL, and SQLite. 
+
+Additionally, support for JSON and date-time types is limited. 
+Please take this into consideration when using these functions.
+
 
 ## Getting started with reading from SQL database
 
@@ -28,25 +34,25 @@ after that, you need to add a dependency for a JDBC driver for the used database
 For MariaDB:
 
 ```kotlin
-implementation("org.mariadb.jdbc:mariadb-java-client:3.1.4")
+implementation("org.mariadb.jdbc:mariadb-java-client:$version")
 ```
 
 For PostgreSQL:
 
 ```kotlin
-implementation("org.postgresql:postgresql:42.6.0")
+implementation("org.postgresql:postgresql:$version")
 ```
 
 For MySQL:
 
 ```kotlin
-implementation("mysql:mysql-connector-java:8.0.33")
+implementation("mysql:mysql-connector-java:$version")
 ```
 
 For SQLite:
 
 ```kotlin
-implementation("org.xerial:sqlite-jdbc:3.42.0.1")
+implementation("org.xerial:sqlite-jdbc:$version")
 ```
 
 In the second, be sure that you can establish a connection to the database.

gradle/libs.versions.toml

@@ -7,7 +7,7 @@ dokka = "1.8.10"
 libsPublisher = "0.0.60-dev-30"
 # "Bootstrap" version of the dataframe, used in the build itself to generate @DataSchema APIs,
 # dogfood Gradle / KSP plugins in tests and idea-examples modules
-dataframe = "0.12.0"
+dataframe = "0.12.1"
 korro = "0.1.5"
 kover = "0.6.0-Beta"