Skip to content

Commit 4e767f6

Browse files
improve concept docs structure
1 parent eac6a31 commit 4e767f6

30 files changed

+99
-197
lines changed

docs/StardustDocs/c.list

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
<!DOCTYPE categories
33
SYSTEM "https://resources.jetbrains.com/writerside/1.0/categories.dtd">
44
<categories>
5-
5+
<category id="related" name="Related topics" order="1"/>
66
</categories>

docs/StardustDocs/d.tree

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,19 @@
2121
<toc-element topic="gettingStartedDatalore.md"/>
2222
<toc-element topic="gettingStartedGradleAdvanced.md"/>
2323
</toc-element>
24-
<toc-element topic="overview.md">
24+
<toc-element topic="concepts.md">
2525
<toc-element topic="apiLevels.md">
2626
<toc-element topic="stringApi.md"/>
2727
<toc-element topic="extensionPropertiesApi.md"/>
2828
</toc-element>
29+
<toc-element topic="types.md">
30+
<toc-element topic="DataFrame.md"/>
31+
<toc-element topic="DataColumn.md"/>
32+
<toc-element topic="DataRow.md"/>
33+
</toc-element>
2934
<toc-element topic="hierarchical.md"/>
35+
<toc-element topic="nanAndNa.md"/>
36+
<toc-element topic="numberUnification.md"/>
3037
<toc-element topic="schemas.md">
3138
<toc-element topic="schemasGradle.md"/>
3239
<toc-element topic="schemasJupyter.md"/>
@@ -36,20 +43,15 @@
3643
<toc-element topic="schemasImportSqlGradle.md"/>
3744
<toc-element topic="schemasImportOpenApiGradle.md"/>
3845
<toc-element topic="schemasImportOpenApiJupyter.md"/>
46+
<toc-element topic="DataSchemaGenerationMethods.md"/>
47+
<toc-element topic="DataSchemaGenerationGradle.md"/>
3948
</toc-element>
4049
</toc-element>
41-
<toc-element topic="types.md">
42-
<toc-element topic="DataFrame.md"/>
43-
<toc-element topic="DataColumn.md"/>
44-
<toc-element topic="DataRow.md"/>
45-
</toc-element>
4650
<toc-element topic="Compiler-Plugin.md">
4751
<toc-element topic="staticInterpretation.md"/>
4852
<toc-element topic="dataSchema.md"/>
4953
<toc-element topic="compilerPluginExamples.md"/>
5054
</toc-element>
51-
<toc-element topic="nanAndNa.md"/>
52-
<toc-element topic="numberUnification.md"/>
5355
<toc-element topic="operations.md">
5456
<toc-element topic="create.md">
5557
<toc-element topic="createColumn.md" toc-title="DataColumn"/>
@@ -199,8 +201,6 @@
199201
<toc-element topic="jupyterRendering.md"/>
200202
</toc-element>
201203
</toc-element>
202-
<toc-element topic="DataSchema-Data-Classes-Generation.md">
203-
<toc-element topic="gradleReference.md"/>
204-
</toc-element>
205204
<toc-element topic="_shadow_resources.md" hidden="true"/>
205+
<toc-element topic="Support.md"/>
206206
</instance-profile>
Lines changed: 1 addition & 0 deletions
Loading

docs/StardustDocs/topics/ColumnSelectors.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,7 @@ For instance, excluding `userData.age`:
260260
`df.select { colsAtAnyDepth { "a" in it.name() } except userData.age }`
261261

262262
Note that the selection of columns to exclude from column sets is always done relative to the outer scope.
263-
Use the [Extension Properties API](extensionPropertiesApi.md) to prevent scoping issues if possible.
263+
Use the [Extension Properties API](concepts/extensionPropertiesApi.md) to prevent scoping issues if possible.
264264

265265
> Special case: If a column that needs to be removed appears multiple times in the [`ColumnSet`](#column-resolvers),
266266
> it is excepted each time it is encountered (including inside [Column Groups](DataColumn.md#columngroup)).
@@ -392,19 +392,19 @@ This function behaves the same as [`cols {}` and `[{}]`](ColumnSelectors.md#cols
392392
Creates a [`ColumnSet`](#column-resolvers) containing the columns from both the left and right side of the function. This allows
393393
you to combine selections or simply select multiple columns at once.
394394

395-
Any combination of [AccessApi](apiLevels.md) can be used on either side of the `and` operator.
395+
Any combination of [AccessApi](concepts/apiLevels.md) can be used on either side of the `and` operator.
396396

397397
Note, while you can write `col1 and col2 and col3...`, it may be more concise to use
398398
[`cols(col1, col2, col3...)`](ColumnSelectors.md#cols) instead. The only downside is that you can't mix
399-
[Access APIs](apiLevels.md) with that notation.
399+
[Access APIs](concepts/apiLevels.md) with that notation.
400400

401401
##### Rename {collapsible="true"}
402402
`colA named "colB"`, `colA into namedColAccessor`
403403

404404
Renaming a column in the Columns Selection DSL is done by calling the infix functions
405405
`named` or `into`.
406406
They behave exactly the same, so it's up to contextual preference which one to use.
407-
Any combination of [Access API](apiLevels.md) can be used to specify the column to rename
407+
Any combination of [Access API](concepts/apiLevels.md) can be used to specify the column to rename
408408
and which name should be used instead.
409409

410410
##### Expr (Column Expression) {collapsible="true"}

docs/StardustDocs/topics/Home.topic

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
<primary>
2121
<title>First steps</title>
2222
<a href="gettingStartedKotlinNotebook.md"/>
23-
<a href="overview.md"/>
23+
<a href="concepts.md"/>
2424
<a href="operations.md"/>
2525
<a href="read.md">Reading from files: CSV, JSON, ApacheArrow</a>
2626
</primary>
@@ -32,7 +32,6 @@
3232
<a href="readSqlDatabases.md"/>
3333
</secondary>
3434

35-
3635
</section-starting-page>
3736

3837

docs/StardustDocs/topics/Support.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Support
2+
3+
* <img src="github-mark.svg" alt="GitHub logo" height="24"/>
4+
[**Issue Tracker**](https://github.com/Kotlin/dataframe/issues)
5+
6+
If you find a bug or have an idea for a new feature,
7+
file an issue in our [DataFrame GitHub repository](https://github.com/Kotlin/dataframe).
8+
9+
* <img src="https://kotlinlang.org/docs/images/slack.svg" alt="Slack logo" height="24"/>
10+
[**Community**](https://github.com/Kotlin/dataframe/issues)
11+
12+
Peer-to-peer support is available on the Kotlin Slack
13+
[#datascience](https://kotlinlang.slack.com/archives/C4W52CFEZ) channel
14+
([request an invite](https://surveys.jetbrains.com/s3/kotlin-slack-sign-up?_gl=1*1ssyqy3*_gcl_au*MTk5NzUwODYzOS4xNzQ2NzkxMDMz*FPAU*MTk5NzUwODYzOS4xNzQ2NzkxMDMz*_ga*MTE0ODQ1MzY3OS4xNzM4OTY1NzM3*_ga_9J976DJZ68*czE3NTE1NDUxODUkbzIyNyRnMCR0MTc1MTU0NTE4NSRqNjAkbDAkaDA.)).
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/StardustDocs/topics/gradleReference.md renamed to docs/StardustDocs/topics/concepts/DataSchemaGenerationGradle.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[//]: # (title: Gradle plugin reference)
1+
[//]: # (title: Data Shemas Generation in Gradle)
22

33
This page describes the Gradle plugin that generates `@DataSchema` from data samples.
44
```Kotlin

0 commit comments

Comments
 (0)