Skip to content

Added links from KDocs to website docs - #2026

Open
Allex-Nik wants to merge 16 commits into
masterfrom
link-kdocs-to-website-docs
Open

Added links from KDocs to website docs#2026
Allex-Nik wants to merge 16 commits into
masterfrom
link-kdocs-to-website-docs

Conversation

@Allex-Nik

@Allex-Nik Allex-Nik commented Aug 8, 2026

Copy link
Copy Markdown
Collaborator

Fixes #1600
Helps #898

  • Add missing links from KDocs to the website and fix incorrect links
  • Update some website pages so that they contain the information the KDocs refer to
  • Add some new pages to point to from KDocs

Comment thread core/api/core.api Outdated

public abstract interface class org/jetbrains/kotlinx/dataframe/documentation/DocumentationUrls$ColumnArithmetics {
}

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@Jolanrensen should DocumentationUrls be in API?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

no, the whole file is excluded from sources. It seems API dump picks up the wrong sources

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Let's fix it with #1491

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I've reverted core.api

Comment thread core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/none.kt Outdated
Returns the first value in this [`DataColumn`](DataColumn.md). If the [`DataColumn`](DataColumn.md) is empty, throws an exception.

If a predicate is specified, returns the first value in this [`DataColumn`](DataColumn.md) that matches the predicate.
Throws an exception if the [`DataColumn`](DataColumn.md) contains no elements matching the predicate.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Provide examples please

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Done

Comment thread docs/StardustDocs/topics/count.md Outdated
<inline-frame src="resources/org.jetbrains.kotlinx.dataframe.samples.api.Analyze.countAggregation.html" width="100%"/>
<!---END-->

When called on a [`DataRow`](DataRow.md), returns the number of columns in this [`DataRow`](DataRow.md). If a predicate

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Really hard to understand without examples

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Done

@@ -1,16 +0,0 @@
[//]: # (title: shuffle)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Why remove it?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

There were two files named shuffle.md: topics/shuffle.md and a more detailed and newer (with samples from the samples module) topics/operations/utils/shuffle.md. Only the latter was used on the website. So I think the older topics/shuffle.md is outdated.

I have also deleted the outdated sample in core/.../Modify.kt used in the old shuffle.md.

Comment thread docs/StardustDocs/topics/sortBy.md Outdated
@AndreiKingsley

Copy link
Copy Markdown
Collaborator

Generally good!

@Allex-Nik
Allex-Nik force-pushed the link-kdocs-to-website-docs branch from aa37cff to 0e4737a Compare August 11, 2026 15:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Ensure all KDocs link to corresponding website documentation pages

3 participants