Create Automatic Tests for Documentation Examples #211
Description
🛠️ Task
What Needs to Be Done
The Docusaurus documentation currently has parts that give concrete examples of how to use the library. These examples are untested. If the source code of the library changes, the examples might not work anymore if the documentation is not updated accordingly.
Therefore, creating test cases as GitHub workflows for those examples would be great. For this, the content needs to be extracted from the markdown files into separate files that can be automatically tested in a pipeline. Here, the source code needs to be integrated into the markdown file instead of copied and pasted (no redundant content).
This issue is completed when two tasks are done:
- The examples are automatically tested as GitHub workflow / pipeline steps and automatically checked on every pull request
- The content is dynamically embedded from the files inside the documentation
Additional Context
Current examples:
- Usage of the watermarker library in Kotlin: https://fraunhoferisst.github.io/TREND/docs/usage/watermarker/kotlin/
- Usage of the watermarker library in Java: https://fraunhoferisst.github.io/TREND/docs/usage/watermarker/java/