-
Notifications
You must be signed in to change notification settings - Fork 6
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 linting for the documentation and fix any current issues #149
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This reverts commit e11df23.
tyrann0us
reviewed
Aug 13, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for working on this! Left some inline comments and questions.
Also, why does Markdownlint complain about italics?
Co-authored-by: Philipp Bammes <[email protected]> Signed-off-by: Mészáros Róbert <[email protected]>
Co-authored-by: Philipp Bammes <[email protected]> Signed-off-by: Mészáros Róbert <[email protected]>
tyrann0us
approved these changes
Aug 13, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Co-authored-by: Philipp Bammes <[email protected]> Signed-off-by: Mészáros Róbert <[email protected]>
Chrico
approved these changes
Aug 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please check if the PR fulfills these requirements
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
Feature, docs update.
What is the current behavior? (You can also link to an open issue here)
There's no linting set up for the documentation, which has resulted in some inconsistencies.
What is the new behavior (if this is a feature change)?
Markdown files are linted when updated or newly added, and the current documentation passes the linting.
Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)
No.
Other information:
None.