@@ -21,3 +21,27 @@ See the [KDoc Preprocessing Guide](../KDOC_PREPROCESSING.md) for more informatio
2121KDocs can also be exported to HTML, for them to be reused on the website.
2222Elements annotated with ` @ExportAsHtml ` will have their generated content be copied over to
2323[ docs/StardustDocs/resources/snippets/kdocs] ( ../docs/StardustDocs/resources/snippets/kdocs ) .
24+
25+ ### ~~ Korro~~ (NOTE: This is being moved to [ : samples ] ( ../samples ) )
26+
27+ > [ Should be removed and moved to ` :samples ` module] ( https://github.com/Kotlin/dataframe/issues/898 ) .
28+
29+ Tests in this module contain code samples used for import into documentation
30+ using [ Korro] ( https://github.com/devcrocod/korro ) .
31+
32+
33+ ### ~~ Explainer dataframes~~ (NOTE: This is being moved to [ : samples ] ( ../samples ) )
34+
35+ > [ Should be removed and migrated to SampleHelper] ( https://github.com/Kotlin/dataframe/issues/898 ) .
36+
37+ Aside from code samples, ` @TransformDataFrameExpressions ` annotated test functions also generate sample
38+ dataframe HTML files that can be used as iFrames on the documentation website.
39+ They are tested, generated, and copied over to [ docs/StardustDocs/resources/snippets] ( ../docs/StardustDocs/resources/snippets ) by
40+ our "explainer" [ plugin callback proxy] ( ./src/test/kotlin/org/jetbrains/kotlinx/dataframe/explainer ) ,
41+ which hooks into [ the TestBase class] ( ./src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api/TestBase.kt ) and
42+ retrieves the intermediate DataFrame expressions thanks to our "explainer" compiler plugin
43+ [ :plugins: expressions-converter ] ( ../plugins/expressions-converter ) .
44+
45+ We can also generate "normal" DataFrame samples for the website. This can be done using the
46+ [ OtherSamples class] ( ./src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api/OtherSamples.kt ) . Generated
47+ HTML files will be stored in [ docs/StardustDocs/resources/snippets/manual] ( ../docs/StardustDocs/resources/snippets/manual ) .
0 commit comments