Merge pull request #1164 from Kotlin/json-post-exclude-docs

json module docs

Author: Jolanrensen

docs/StardustDocs/topics/gettingStartedGradleAdvanced.md

@@ -124,6 +124,7 @@ dependencies {
     // Artifact containing all APIs and implementations
     implementation("org.jetbrains.kotlinx:dataframe-core:%dataFrameVersion%")
     // Optional formats support
+    implementation("org.jetbrains.kotlinx:dataframe-json:%dataFrameVersion%")
     implementation("org.jetbrains.kotlinx:dataframe-csv:%dataFrameVersion%")
     implementation("org.jetbrains.kotlinx:dataframe-excel:%dataFrameVersion%")
     implementation("org.jetbrains.kotlinx:dataframe-jdbc:%dataFrameVersion%")
@@ -149,6 +150,8 @@ dependencies {
     // Artifact containing all APIs and implementations
     implementation 'org.jetbrains.kotlinx:dataframe-core:%dataFrameVersion%'
     // Optional formats support 
+    implementation 'org.jetbrains.kotlinx:dataframe-json:%dataFrameVersion%'
+    implementation 'org.jetbrains.kotlinx:dataframe-csv:%dataFrameVersion%'
     implementation 'org.jetbrains.kotlinx:dataframe-excel:%dataFrameVersion%'
     implementation 'org.jetbrains.kotlinx:dataframe-jdbc:%dataFrameVersion%'
     implementation 'org.jetbrains.kotlinx:dataframe-arrow:%dataFrameVersion%'
@@ -168,6 +171,16 @@ dependencies {
 
 </tabs>
 
+<note>
+`dataframe-json` is included with `dataframe-csv` and `dataframe-excel` by default. This is to interact with
+JSON structures inside CSV and Excel files. If you don't need this functionality, you can exclude it like:
+```kts
+implementation("org.jetbrains.kotlinx:dataframe-csv:%dataFrameVersion%") {
+    exclude("org.jetbrains.kotlinx", "dataframe-json")
+}
+```
+</note>
+
 #### Linter configuration
 
 We provide a Gradle plugin that generates interfaces with your data.

docs/StardustDocs/topics/parse.md

@@ -43,7 +43,7 @@ df.parse { age and weight }
 * [`Double` (with optional locale settings)](#parsing-doubles)
 * `Boolean`
 * `BigDecimal`
-* `JSON` (arrays and objects)
+* `JSON` (arrays and objects) (requires the `org.jetbrains.kotlinx:dataframe-json` dependency)
 
 ### Parser Options
 

docs/StardustDocs/topics/read.md

@@ -286,6 +286,14 @@ val df = DataFrame.readCsv(
 
 ## Read from JSON
 
+Before you can read data from JSON, make sure you have the following dependency:
+
+```kotlin
+implementation("org.jetbrains.kotlinx:dataframe-json:$dataframe_version")
+```
+
+It's included by default if you have `org.jetbrains.kotlinx:dataframe:$dataframe_version` already.
+
 To read a JSON file, use the `.readJson()` function. JSON files can be read from a file or a URL.
 
 Note that after reading a JSON with a complex structure, you can get hierarchical