This folder holds the source code of our documentation website: kotlin.github.io/dataframe.
It's built using Writerside and published
by a Github Action.
The file structure largely mirrors the default Writerside structure.
For instance, if you want to add a new page to the website, this needs to be stored as an .md file in the
StardustDocs/topics folder,
and included in the StardustDocs/d.tree file.
Images all README files can be stored in docs/imgs.
@TransformDataFrameExpressions annotated test functions generate sample
dataframe HTML files that can be used as iFrames on the documentation website.
They are tested, generated, and copied over to docs/StardustDocs/snippets by
our "explainer" plugin callback proxy,
which hooks into the TestBase class and
retrieves the intermediate DataFrame expressions thanks to
our "explainer" compiler plugin :plugins:expressions-converter.
We can also generate "normal" DataFrame samples for the website. This can be done using the OtherSamples class. Generated HTML files will be stored in docs/StardustDocs/snippets/manual.
KDocs can also be exported to HTML, for them to be reused on the website.
Elements annotated with @ExportAsHtml will have their generated content be copied over to
docs/StardustDocs/snippets/kdocs.
Code samples for the documentation website reside in core/.../test/.../samples/api
(for samples that depend solely on dataframe-core),
and tests/.../samples/api (for samples can depend on other I/O modules)
and they are copied over to Markdown files in docs/StardustDocs/topics
by Korro.