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

Add Markdown Linter for Documentation #70

Open
mhellmeier opened this issue May 29, 2024 · 0 comments
Open

Add Markdown Linter for Documentation #70

mhellmeier opened this issue May 29, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation feature New feature or request pipeline Build, Action, CI/CD etc.

Comments

@mhellmeier
Copy link
Member

🚀 Feature Request

Current Problem

The structure and format of the markdown files inside the documentation (Docusaurus) aren't specified.

Proposed Solution

A markdown linter should be used to check and improve the structure of the documentation. Further, a new GitHub workflow action is needed so that every change of a markdown file is directly checked in every pull request.

Additional Context

At the beginning, the currently available markdown linters must be checked and evaluated. Popular ones are:

@mhellmeier mhellmeier added documentation Improvements or additions to documentation feature New feature or request pipeline Build, Action, CI/CD etc. labels May 29, 2024
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 feature New feature or request pipeline Build, Action, CI/CD etc.
Projects
None yet
Development

No branches or pull requests

1 participant