fix: resolve markdownlint errors across documentation#1571
Open
amuzip wants to merge 1 commit intogithub:mainfrom
Open
fix: resolve markdownlint errors across documentation#1571amuzip wants to merge 1 commit intogithub:mainfrom
amuzip wants to merge 1 commit intogithub:mainfrom
Conversation
- Add language specifiers to fenced code blocks (bash, text) - Fix whitespace issues around code fences - Disable MD036 (emphasis as heading) for intentional warning text - Disable MD060 (table column style) for existing table formats Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR resolves markdownlint errors across documentation files by adding language specifiers to code blocks, fixing whitespace issues, and disabling specific markdownlint rules that conflict with the project's documentation style.
Changes:
- Added
bashandtextlanguage specifiers to previously untagged code blocks - Fixed whitespace around code fences (added blank lines in list items containing code blocks)
- Disabled MD036 (emphasis as heading) to allow bold text for labels like Cause: and Fix:
- Disabled MD060 (table column style) to maintain existing table formatting
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
.markdownlint-cli2.jsonc |
Disabled MD036 and MD060 rules to accommodate project's documentation style |
templates/commands/specify.md |
Added blank lines around code blocks within nested lists for proper markdown spacing |
docs/upgrade.md |
Added text language specifier to warning message code blocks and fixed whitespace around code fences |
CONTRIBUTING.md |
Added bash language specifier to shell command 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
Test plan
npx markdownlint-cli2 "**/*.md"- passes with 0 errors🤖 Generated with Claude Code