Open
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds a GitHub Actions workflow to enforce Markdown linting standards on pull requests and pushes to main. The workflow uses markdownlint-cli2-action to automatically check Markdown files against project-defined rules.
- Updates the job name from "lint" to "markdownlint" for clarity
- Upgrades markdownlint-cli2-action from v16 to v17
- Simplifies configuration by relying on repository config files instead of inline globs
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.
Summary
Add a minimal GitHub Actions workflow to run markdownlint on every PR and on pushes to
main, enforcing our “strict but low-churn” Markdown rules.Linked Artifacts (relative paths)
Checklists
Labs (if included)
labs/<lab>/assets/KBs (if included)
Scenarios (if included)
Notes
.github/workflows/markdownlint.ymlDavidAnson/markdownlint-cli2-action@v17.markdownlint-cli2.jsonc(globs/ignores) and.markdownlint.jsonc(rules)README.mdand.github/**/*.mdHow to Verify (for reviewers)
markdownlintlocally and confirm behavior matches CI (same configs and ignore patterns)