Add markdownlint to CI for Markdown file validation#137
Merged
Conversation
- Create .markdownlint.json with project-specific rules - Add markdownlint setup and check step to CI lint job - Add lint-markdown target to Makefile - Fix existing violations in markdown files - Update CLAUDE.md and CONTRIBUTING.md documentation Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR introduces markdownlint validation to the CI pipeline to enforce consistent Markdown formatting across documentation files. This addresses issue #134 by catching common formatting issues like inconsistent heading levels, improper list indentation, and missing code block language identifiers.
Changes:
- Added markdownlint configuration and CI integration
- Fixed existing Markdown formatting violations in documentation files
- Updated project documentation to reflect the new linting requirement
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
.markdownlint.json |
Defines project-specific markdownlint rules including 4-space list indentation and disabled line-length checks |
.github/workflows/ci.yml |
Adds markdownlint validation step to the lint job using DavidAnson/markdownlint-cli2-action |
Makefile |
Adds lint-markdown target for local validation and includes it in the main lint target |
CLAUDE.md |
Adds code block language identifiers and documents markdownlint configuration |
CONTRIBUTING.md |
Documents the new markdownlint validation requirement |
docs/how-to/how-to-workflow.md |
Adds blank lines after "Do:" and "Don't:" headings per markdown formatting rules |
docs/how-to/how-to-test-man-page.md |
Corrects heading levels from ### to ## for proper hierarchy |
.claude/commands/issue-checkout.md |
Adds text language identifier to code blocks |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
1 participant
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
Enforce consistent Markdown formatting across documentation files by adding markdownlint to the CI lint job. This catches formatting issues like heading levels, list indentation, and code block formatting.
Related Issues
Fixes #134
Changes
.markdownlint.jsonwith project-specific rules (4-space list indent, line-length disabled)lint-markdowntarget to Makefile for local validation