Skip to content

Setup samples validation in documentation via knit #76

Open
@whyoleg

Description

@whyoleg

Currently, samples are just code blocks, which could easily become outdated. At this moment, the easiest and most promising way for keeping those runnable and correct is to use https://github.com/Kotlin/kotlinx-knit
It parses Markdown documents, allows for linking to code, and extracts samples into runnable tests.
kotlinx.coroutines and kotlinx.serialization setup can be used as an example for the implementation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions