Improve Markdown linting and use it on more files #4515
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
ralfhandl
reviewed
Mar 28, 2025
There was a problem hiding this comment.
mdvis still listed independencies: can we remove it?markdownlint-cli2is not declared as a dependency,devDependenciesstill lists the traditionalmarkdownlint-clithat we used before
|
The It also calls
|
ralfhandl
reviewed
Mar 30, 2025
| @@ -1,14 +1,16 @@ | |||
| # Technical Oversight Board ("TOB") | |||
|
|
|||
| ## Description: | |||
| ## Description | |||
| > | |||
There was a problem hiding this comment.
Suggested change
| > |
Empty line after headline instead of block-quoted empty line
ralfhandl
requested changes
Mar 30, 2025
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.
Fixes #4249 which asks for Markdown linting to be applied to the markdown files at the root level of the repo.
Points to look for:
mdv, it is outdated and we can do most of what's needed with markdownlint. My only concern is that we're missing some formatting of json/yaml/abnf code examples, so we should consider any options on that (and be careful with them in the meantime!)sedmanouvre to fix it. I don't think the benefits of using prettier are worth having this sort of hackery in the project so we'll use the markdownlint "fix" feature instead and I removed the script.I realise that
src/oas.mdisn't present on this branch but the same configuration seemed to be okay with what's currently on bothv3.1-devandv3.2-dev.