Skip to content

Add mechanism to verify that source code in documentation is valid #7951

@andygrove

Description

@andygrove

Is your feature request related to a problem or challenge?

Our user guide and library guide contain code samples, but these can quickly become outdated and stop compiling and we have to automated way to check if they still compile.

Describe the solution you'd like

I propose that code samples be written as unit tests and that we then use a script to insert these code samples into the documentation when we publish the docs.

Describe alternatives you've considered

No response

Additional context

No response

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions