Skip to content

Added KDocs guidelines - #1660

Merged
AndreiKingsley merged 14 commits into
masterfrom
documentation-guidelines
Mar 10, 2026
Merged

Added KDocs guidelines#1660
AndreiKingsley merged 14 commits into
masterfrom
documentation-guidelines

Conversation

@AndreiKingsley

@AndreiKingsley AndreiKingsley commented Jan 19, 2026

Copy link
Copy Markdown
Collaborator

Closes #1689

@Jolanrensen

Copy link
Copy Markdown
Collaborator

For visibility, we'd need to merge this with https://github.com/Kotlin/dataframe/blob/master/KDOC_PREPROCESSING.md#kodex-conventions-in-dataframe. It may be okay to have two documents:

  • Kdoc preprocessing
  • Documenting guide

but they should probably link to each other. A single document could also work

Comment thread docs/KDocs-Guidelines.md Outdated
Comment thread docs/KDocs-Guidelines.md Outdated
Comment thread docs/KDocs-Guidelines.md Outdated
Comment thread docs/KDocs-Guidelines.md Outdated
Comment thread docs/KDocs-Guidelines.md Outdated
Comment thread docs/KDocs-Guidelines.md Outdated
Comment thread docs/KDocs-Guidelines.md Outdated
Comment thread docs/KDocs-Guidelines.md Outdated
Comment thread docs/KDocs-Guidelines.md Outdated
Comment thread docs/KDocs-Guidelines.md Outdated
Comment thread docs/KDocs-Guidelines.md Outdated
Comment thread docs/KDocs-Guidelines.md Outdated
Comment thread docs/KDocs-Guidelines.md Outdated
@AndreiKingsley AndreiKingsley changed the title Documentation guidelines KDocs guidelines Feb 17, 2026
@AndreiKingsley

Copy link
Copy Markdown
Collaborator Author

Almost finished, but requires #1683

@AndreiKingsley
AndreiKingsley marked this pull request as ready for review March 6, 2026 16:16
@AndreiKingsley AndreiKingsley changed the title KDocs guidelines Added KDocs guidelines Mar 9, 2026

@Jolanrensen Jolanrensen left a comment

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.

Thanks! This is quite extensive :)

Comment thread KDOC_GUIDELINES.md Outdated
Comment thread KDOC_GUIDELINES.md Outdated
Comment thread KDOC_GUIDELINES.md Outdated
Comment thread KDOC_GUIDELINES.md Outdated
Comment thread KDOC_GUIDELINES.md Outdated
Comment thread KDOC_GUIDELINES.md Outdated
Comment thread KDOC_GUIDELINES.md Outdated
Comment thread KDOC_GUIDELINES.md
Comment thread KDOC_GUIDELINES.md Outdated
Comment thread KDOC_GUIDELINES.md

A fully interactive, single-source-of-truth grammar for the Columns Selection DSL!


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.

Do you already link back to KODEX_KDOC_PREPROCESSING.md from this file somewhere? If not, please add it so people that want to find more information about KoDEx can find 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.

I do

Please read about 
the [KDocs preprocessing using KoDEx](KODEX_KDOC_PREPROCESSING.md) before working with Kotlin DataFrame KDocs.

@AndreiKingsley
AndreiKingsley merged commit f018647 into master Mar 10, 2026
5 of 6 checks passed
@AndreiKingsley
AndreiKingsley deleted the documentation-guidelines branch March 10, 2026 10:18
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.

Make KDoc guidelines

2 participants