Add Markdown documentation linting#2446
Open
msteslov wants to merge 5 commits into
Open
Conversation
Signed-off-by: msteslov <msteslov@edu.hse.ru>
26adcca to
ecf42c5
Compare
dstebila
previously approved these changes
May 25, 2026
xuganyu96
previously approved these changes
May 25, 2026
Contributor
xuganyu96
left a comment
There was a problem hiding this comment.
LGTM. Thank you for the contribution.
Signed-off-by: Douglas Stebila <dstebila@uwaterloo.ca> skip-checks: true
Signed-off-by: Douglas Stebila <dstebila@uwaterloo.ca>
Signed-off-by: Douglas Stebila <dstebila@uwaterloo.ca>
Signed-off-by: Douglas Stebila <dstebila@uwaterloo.ca>
xuganyu96
reviewed
May 26, 2026
Contributor
There was a problem hiding this comment.
I am sorry to have to walk back on my previous approval. The code change makes sense to me, but the choice of tool could use some justification. I did a quick search and found other markdown linters written in Ruby (markdownlint), Python (pymarkdown), and Rust (rumdl), and many others. It feels a tiny bit uncomfortable to introduce NPM into dev dependencies. I intuitively prefer keeping dev dependencies either in the Python ecosystem or as small binaries. Of course if markdownlint-cli is indeed a much more mature project than the other choices, then I am okay with introducing it into liboqs.
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
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 #1785.
Adds a Markdown linting job to the basic CI workflow using markdownlint-cli2.
Testing:
npx --yes markdownlint-cli2@0.22.1 --config .markdownlint.yml "**/*.md" "#build" "#**/build"actionlint -shellcheck "" .github/workflows/basic.ymlAI assistance was used for repository inspection and drafting; I reviewed and verified the final changes.