Skip to content

[Feature Request]: Automatically extract all the code examples from the documentation and run them as "tests" #289

@Weyaaron

Description

@Weyaaron

Problem statement

Our documentation uses a lot of examples. We should maintain them, which includes updating them when the codebase beneath changes. To ease maintenance, we may implement a script that runs all the provided examples. This could be done continuously with each PR or in a manual step before each release.

Solution

The solution probably involves some sort of markdown parsing, and if it should run continuously, altering the CI accordingly.

Additional Context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    featureHave an idea on how to improve the code base? Come forward and let us know.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions