Skip to content

Commit 901ffa2

Browse files
Merge pull request #1357 from Kotlin/setup_docs
Setup docs
2 parents adb6e05 + f83e3f7 commit 901ffa2

40 files changed

+583
-592
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Explore [**documentation**](https://kotlin.github.io/dataframe) for details.
4242
You could find the following articles there:
4343

4444
* [Guides and Examples](https://kotlin.github.io/dataframe/guides-and-examples.html)
45-
* [Get started with Kotlin DataFrame](https://kotlin.github.io/dataframe/gettingstarted.html)
45+
* [Get started with Kotlin DataFrame](https://kotlin.github.io/dataframe/setup.html)
4646
* [Working with Data Schemas](https://kotlin.github.io/dataframe/schemas.html)
4747
* [Setup compiler plugin in Gradle project](https://kotlin.github.io/dataframe/compiler-plugin.html)
4848
* [Full list of all supported operations](https://kotlin.github.io/dataframe/operations.html)
@@ -61,7 +61,7 @@ Check out this [notebook with new features](examples/notebooks/feature_overviews
6161
## Setup
6262

6363
> For more detailed instructions on how to get started with Kotlin DataFrame, refer to the
64-
> [Getting Started](https://kotlin.github.io/dataframe/gettingstarted.html).
64+
> [Getting Started](https://kotlin.github.io/dataframe/setup.html).
6565
6666
### Kotlin Notebook
6767

docs/StardustDocs/d.tree

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@
1414
</toc-element>
1515
</toc-element>
1616

17-
<toc-element topic="gettingStarted.md" accepts-web-file-names="installation.html">
18-
<toc-element topic="gettingStartedKotlinNotebook.md"/>
19-
<toc-element topic="gettingStartedGradle.md"/>
20-
<toc-element topic="gettingStartedJupyterNotebook.md"/>
21-
<toc-element topic="gettingStartedDatalore.md"/>
22-
<toc-element topic="gettingStartedGradleAdvanced.md"/>
17+
<toc-element topic="Setup.md" accepts-web-file-names="gettingstarted">
18+
<toc-element topic="SetupKotlinNotebook.md" accepts-web-file-names="gettingstartedkotlinnotebook.html"/>
19+
<toc-element topic="SetupGradle.md" accepts-web-file-names="gettingstartedgradle.html"/>
20+
<toc-element topic="SetupJupyter.md" accepts-web-file-names="gettingstartedjupyternotebook.html"/>
21+
<toc-element topic="SetupDatalore.md" accepts-web-file-names="gettingstarteddatalore.html"/>
22+
<toc-element topic="SetupAndroid.md" accepts-web-file-names="gettingstartedgradleadvanced.html"/>
2323
<toc-element topic="Modules.md"/>
2424
</toc-element>
2525
<toc-element topic="concepts.md" accepts-web-file-names="overview.html">
@@ -209,4 +209,5 @@
209209
<toc-element topic="Support.md"/>
210210
<toc-element topic="FAQ.md"/>
211211
<toc-element topic="Migration-From-Plugins.md"/>
212+
<toc-element topic="SetupCustomGradle.md"/>
212213
</instance-profile>
-79.1 KB
Binary file not shown.
-79.1 KB
Binary file not shown.
-119 KB
Binary file not shown.
-119 KB
Binary file not shown.
96.6 KB
Loading
74.4 KB
Loading

docs/StardustDocs/topics/FAQ.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ To stay updated on progress, subscribe to the
2727
Yes — Kotlin DataFrame can be used in Android projects.
2828

2929
There is no dedicated Android artifact yet, but you can include the standard **JVM artifact**
30-
by setting up a [custom Gradle configuration](gettingStartedGradleAdvanced.md).
30+
by setting up a [custom Gradle configuration](SetupAndroid.md).
3131

3232
## How to start with Kotlin DataFrame ?
3333

@@ -41,7 +41,7 @@ to explore various use cases and deepen your understanding of Kotlin DataFrame.
4141

4242
For the best experience, Kotlin DataFrame is most effective in an interactive environment.
4343

44-
- **[Kotlin Notebook](gettingStartedKotlinNotebook.md)** is ideal for exploring Kotlin DataFrame.
44+
- **[Kotlin Notebook](SetupKotlinNotebook.md)** is ideal for exploring Kotlin DataFrame.
4545
Everything works out of the box — interactivity, rich rendering of DataFrames and plots.
4646
You can instantly see the results of each operation, view the contents of your DataFrames after every transformation,
4747
inspect individual rows and columns, and explore data step-by-step in a live and interactive way.
@@ -109,7 +109,7 @@ in a **type-safe** and **name-safe** way.
109109

110110
They are generated automatically when working with Kotlin DataFrame in:
111111

112-
- [Kotlin Notebook](gettingStartedKotlinNotebook.md), where extension properties are generated
112+
- [Kotlin Notebook](SetupKotlinNotebook.md), where extension properties are generated
113113
after each cell execution.
114114
- A Kotlin project in [IntelliJ IDEA](https://www.jetbrains.com/idea/) with the
115115
[](Compiler-Plugin.md) enabled, where the properties are generated at compile time.

docs/StardustDocs/topics/Home.topic

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
<primary>
2121
<title>First steps</title>
22-
<a href="gettingStartedKotlinNotebook.md"/>
22+
<a href="SetupKotlinNotebook.md"/>
2323
<a href="concepts.md"/>
2424
<a href="operations.md"/>
2525
<a href="read.md">Reading from files: CSV, JSON, ApacheArrow</a>

0 commit comments

Comments
 (0)