Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create Automatic Tests for Documentation Examples #211

Open
2 tasks
mhellmeier opened this issue Mar 7, 2025 · 0 comments
Open
2 tasks

Create Automatic Tests for Documentation Examples #211

mhellmeier opened this issue Mar 7, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation pipeline Build, Action, CI/CD etc.

Comments

@mhellmeier
Copy link
Member

🛠️ 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:

@mhellmeier mhellmeier added documentation Improvements or additions to documentation pipeline Build, Action, CI/CD etc. labels Mar 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation pipeline Build, Action, CI/CD etc.
Projects
None yet
Development

No branches or pull requests

1 participant