Restructured setup guides to have compiler plugin closer to library dependency setup - #1949
Open
koperagen wants to merge 2 commits into
Open
Restructured setup guides to have compiler plugin closer to library dependency setup#1949koperagen wants to merge 2 commits into
koperagen wants to merge 2 commits into
Conversation
koperagen
commented
Jul 24, 2026
koperagen
commented
Collaborator
- Joined compiler plugin setup with library dependency setup as we discussed
- Updated maven setup, took inspiration from https://kotlinlang.org/docs/power-assert.html#maven
- Compacted Android setup. I believe all these JDK/minSdk were there only because we used to have a lot of extras for Apache Arrow setup. Turns out it doesn't work at all on Android. Our library doesn't impose any additional restrictions on JDK, i believe. Showing setup of 1.8 everywhere seems redundant. Maaybe we should leave minSdk? Let me know what you think.
dataframe doesn't really impose any additional requirements. It looks like leftovers from time when we had extra configuration
koperagen
added
the
documentation
Jolanrensen
reviewed
Jul 27, 2026
| implementation("org.jetbrains.kotlinx:dataframe-json:%dataFrameVersion%") | ||
| implementation("org.jetbrains.kotlinx:dataframe-csv:%dataFrameVersion%") | ||
| // You can add any additional IO modules you like, except for 'dataframe-arrow'. | ||
| // Apache Arrow is not supported well on Android. |
Collaborator
|
We can leave out |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR reorganizes the Kotlin DataFrame setup documentation so the compiler plugin setup is presented alongside the library dependency setup, with refreshed Maven guidance and a more compact Android setup flow.
Changes:
- Restructured Maven/Gradle setup pages into a single “Setup Kotlin DataFrame” section with ordered steps (plugin first, then library dependency).
- Updated Maven compiler plugin configuration text and XML example placement.
- Simplified and reordered Android setup instructions to mirror the same step-based approach.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/StardustDocs/topics/setup/SetupMaven.md | Combines compiler plugin and library dependency instructions into a single step-based setup flow for Maven. |
| docs/StardustDocs/topics/setup/SetupGradle.md | Combines plugin + dependency setup into one flow and updates the incremental compilation note placement/text. |
| docs/StardustDocs/topics/setup/SetupAndroid.md | Reorders content into “plugin then library” steps and compacts the configuration guidance/snippets. |
| docs/StardustDocs/topics/Compiler-Plugin.md | Adjusts Maven setup wording and adds clarifying inline comments in the XML snippet. |
Comments suppressed due to low confidence (2)
docs/StardustDocs/topics/setup/SetupGradle.md:73
- The sentence about Kotlin < 2.4.0 is missing articles/punctuation and no longer explains what
kotlin.incremental=falsedoes or why it's needed. This makes the instruction harder to understand.
In versions older than Kotlin 2.4.0 add following line to your `gradle.properties`:
docs/StardustDocs/topics/setup/SetupAndroid.md:51
- The instruction for Kotlin < 2.4.0 has grammar issues and doesn't explain that
kotlin.incremental=falsedisables incremental compilation or why it’s required.
In versions older than Kotlin 2.4.0 add following line to your `gradle.properties`:
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
74
to
+76
| The DataFrame compiler plugin can be used in Maven projects starting from IntelliJ IDEA 2025.3, available now as EAP builds | ||
|
|
||
| Setup plugin in pom.xml: | ||
| Update the `<kotlin-maven-plugin>` in the `<plugin>` section of your `pom.xml`:: |
Comment on lines
+49
to
+50
| > Requires Kotlin 2.2.20-Beta1 or higher | ||
|
|
Comment on lines
+25
to
+26
| > Requires Kotlin 2.2.20-Beta1 or higher. | ||
|
|
Comment on lines
+89
to
92
| implementation 'org.jetbrains.kotlinx:dataframe-csv:%dataFrameVersion%' | ||
| // You can add any additional IO modules you like, except for 'dataframe-arrow'. | ||
| // Apache Arrow is not supported well on Android. | ||
| } |
Collaborator
|
I will take a look! |
AndreiKingsley
approved these changes
Jul 30, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.