Skip to content

Update Compiler-Plugin.md #1576

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
+62 −13
Open

Update Compiler-Plugin.md #1576

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d747f29
Update Compiler-Plugin.md
koperagen Nov 20, 2025
4b09a62
Update compiler plugin docs structure
koperagen Nov 20, 2025
ec5ae2b
Capitalize titles in compiler plugin docs
koperagen Nov 20, 2025
45ebb18
Add maven configuration for compiler plugin
koperagen Nov 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/StardustDocs/d.tree
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,8 @@
<toc-element topic="schemasImportOpenApiGradle.md"/>
</toc-element>
</toc-element>
<toc-element topic="Compiler-Plugin.md">
<toc-element toc-title="Compiler Plugin">
<toc-element topic="Compiler-Plugin.md"/>
Copy link
Collaborator

@AndreiKingsley AndreiKingsley Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why?

Copy link
Collaborator Author

@koperagen koperagen Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's more obvious:
image

image

For example, kotlinlang docs never use root toc elements for content:
https://kotlinlang.org/docs/all-open-plugin.html#maven

<toc-element topic="staticInterpretation.md"/>
<toc-element topic="dataSchema.md"/>
<toc-element topic="compilerPluginExamples.md"/>
Expand Down
6 changes: 2 additions & 4 deletions docs/StardustDocs/topics/Compiler-Plugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Kotlin DataFrame Compiler Plugin
# Setup And Overview

<web-summary>
Explore the Kotlin DataFrame Compiler Plugin —
Expand Down Expand Up @@ -34,9 +34,7 @@ Check out this video that shows how expressions update the schema of a dataframe

## Setup

Install [IntelliJ IDEA EAP](https://www.jetbrains.com/idea/nextversion/).
Going forward, compiler plugin updates will be released with Kotlin plugin updates.
Next release: 2025.2
We recommend using up-to-date IntelliJ IDEA and Kotlin for the best experience. Minimal supported versions: 2025.2 and 2.2.0.

Setup plugins in `build.gradle.kts`:

Expand Down
2 changes: 1 addition & 1 deletion docs/StardustDocs/topics/compilerPluginExamples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[//]: # (title: Compiler plugin examples)
[//]: # (title: Compiler Plugin Examples)

This page provides a few examples that you can copy directly to your project.
[Schema info](staticInterpretation.md#schema-info) will be a convenient way to observe the result of different operations.
Expand Down
2 changes: 1 addition & 1 deletion docs/StardustDocs/topics/dataSchema.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @DataSchema declarations
# @DataSchema Declarations

`DataSchema` can be used as an argument for [cast](cast.md) and [convertTo](convertTo.md) functions.
It provides typed data access for raw dataframes you read from I/O sources and serves as a starting point for the compiler plugin to derive schema changes.
Expand Down
2 changes: 1 addition & 1 deletion docs/StardustDocs/topics/staticInterpretation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Static interpretation of DataFrame API
# Static Interpretation of DataFrame API

Plugin evaluates dataframe operations, given compile-time known arguments such as constant String, resolved types, property access calls.
It updates the return type of the function call to provide properties that match column names and types.
Expand Down