Open
Conversation
Lint Markdown and make it relatively strict to avoid MkDocs issues. Ignore few rules due to specific use in our model format. For example: - MD034 - Bare URL used / We need that in metadata section - MD036 - Emphasis used instead of a header / We use `*Example*` in description - MD041 - First line in file should be a top level header / Our file line has to be the license line Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com> Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Member
|
I like adding this in, but lets merge this in after RC1 release. |
Updated the Markdown lint workflow to include its own file in the paths for push and pull request events. Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
- Remove duplicated headings - Remove double blank line Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
goneall
approved these changes
Feb 11, 2026
Member
goneall
left a comment
goneall
left a comment
There was a problem hiding this comment.
LGTM - Since we've done the RC1 release, once we get one more review we can merge
Ping @zvr @kestewart
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Lint Markdown and make it relatively strict to avoid MkDocs issues. To reduce work of reviewers.
Ignore few rules due to specific use in our model format. For example:
*Example*in descriptionThis PR also includes few issues reported by Markdownlint, to make the check passes: