feat(lint): Add markdownlint integration - #391
Merged
Merged
Conversation
Signed-off-by: currantw <taylor.curran@improving.com>
Signed-off-by: currantw <taylor.curran@improving.com>
Signed-off-by: currantw <taylor.curran@improving.com>
Signed-off-by: currantw <taylor.curran@improving.com>
Signed-off-by: currantw <taylor.curran@improving.com>
markdownlint integration
… into currantw/add-markdownlint
currantw
commented
May 11, 2026
currantw
commented
May 11, 2026
currantw
commented
May 11, 2026
There was a problem hiding this comment.
Pull request overview
Integrates markdownlint-cli2 into the repo’s existing task-based lint/format workflow to enforce consistent Markdown style across documentation and meta files.
Changes:
- Add
task lint:markdownandtask format:markdown, and wire them intotask lint/task format. - Introduce
.markdownlint-cli2.yamlwith project-specific rule/config overrides and ignore globs. - Apply Markdown cleanup across several docs/templates to satisfy lint rules (heading levels, table separator, code-fence info strings, spacing).
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| Taskfile.yml | Adds markdown lint/format tasks and includes them in aggregate lint/format pipelines. |
| .markdownlint-cli2.yaml | Configures markdownlint-cli2 (rule overrides, gitignore integration, submodule ignores). |
| docs/configuration-architecture-analysis.md | Markdown formatting updates (blank lines, fenced code language). |
| docs/ci-cd.md | Markdown table separator formatting update. |
| DEVELOPER.md | Heading level and lint/format command list updates to include markdown tasks. |
| AGENTS.md | Updates “common commands / quality gates” to include markdown lint/format tasks. |
| .github/pull_request_template.md | Normalizes headings/structure to comply with Markdown linting. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
currantw
commented
May 11, 2026
currantw
enabled auto-merge (squash)
May 12, 2026 00:13
xShinnRyuu
approved these changes
May 12, 2026
Aryex
approved these changes
May 12, 2026
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
Integrate
markdownlint-cli2into the project's lint and format pipelines to enforce consistent markdown style across all.mdfiles. This adds automated structural validation and auto-fix capability for markdown, complementing the existing C#, Rust, YAML, and GitHub Actions linting.Issue Link
Closes #380.
Features and Behaviour Changes
task lint:markdown— checks all markdown files for style violations.task format:markdown— auto-fixes markdown violations in-place.task lintandtask formatrespectively.npx markdownlint-cli2(no separate install step needed, matches existing prettier pattern)..gitignoreviagitignore: trueconfig option.Implementation
gitignore: true— automatically excludes gitignored directories (.kiro/,rust/target/, etc.).siblings_only— allows repeated headings under different parents.valkey-glide/**(read-only submodule containing.mdfiles).Limitations
⚪ None.
Testing
task lint:markdownpasses with 0 errors across 10 linted filestask format:markdownruns successfullyRelated Issues
⚪ None.
Checklist
Tests are added or updated and all checks pass.(No tests applicable — CI/config tooling only)CHANGELOG.md,README.md,DEVELOPER.md, and other documentation files are updated.mainor releasemain, squash otherwise.