[DOCS] Add rule descriptions to the markdownlint config file #1185
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
https://github.com/DavidAnson/markdownlint#rules--aliases Added the markdownlint rule descriptions as comments for convenience
jiayuasu
approved these changes
Jan 6, 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.
https://github.com/DavidAnson/markdownlint#rules--aliases
Added the markdownlint rule descriptions as comments for convenience
Did you read the Contributor Guide?
Is this PR related to a JIRA ticket?
[DOCS] my subject.What changes were proposed in this PR?
Added some extra documentation as comments
How was this patch tested?
Tested by visual inspection and also ran:
pre-commit run --all-fileswhich runs the Markdown linter.
Did this PR include necessary documentation updates?