Skip to content

Fix markdownlint errors causing CI failures - #1

Merged
deyil merged 3 commits into
mainfrom
copilot/fix-markdownlint-errors
Jan 30, 2026
Merged

deyil merged 3 commits into
mainfrom
copilot/fix-markdownlint-errors

Conversation

Copilot AI commented Jan 30, 2026 •

Copy link
Copy Markdown

Fixing Markdownlint Errors

  • Fix docs/quickstart.md (MD030, MD031 errors - list markers and fenced code blocks)
  • Fix README.md (MD022, MD032 errors - heading spacing and list spacing)
  • Fix spec-driven.md (MD022 errors - heading spacing)
  • Fix templates/commands/build.md (MD031, MD009, MD029, MD012 errors - code blocks, trailing spaces, list numbering)
  • Fix templates/commands/plan.md (MD009 errors - trailing spaces)
  • Fix templates/commands/quick.md (MD032, MD031, MD009, MD012 errors - list spacing, code blocks, trailing spaces)
  • Fix templates/commands/status.md (MD031, MD032, MD040 errors - code blocks, list spacing, language specifiers)
  • Fix templates/commands/tasks.md (MD009 errors - trailing spaces)
  • Fix docs/installation.md (MD022, MD032 errors - heading spacing and list spacing)
  • Run markdownlint to verify all fixes
  • Commit and push final changes

Summary

All markdownlint errors from the CI failures have been fixed:

  • MD030: Fixed list markers to have exactly 1 space
  • MD031: Added blank lines around fenced code blocks
  • MD022: Added blank lines around headings
  • MD032: Added blank lines around lists
  • MD009: Removed all trailing spaces
  • MD029: Fixed ordered list numbering to use consistent style
  • MD012: Reduced multiple consecutive blank lines to single lines
  • MD040: Added language specifiers to fenced code blocks (where needed)

Fixed an additional file docs/installation.md that was causing CI failures.

Original prompt

Problem Statement

The markdownlint job is failing with multiple errors across several markdown files. All errors need to be fixed to pass the lint workflow.

Files to Fix

The following files have markdownlint errors that need to be corrected:

  1. docs/quickstart.md
  2. README.md
  3. spec-driven.md
  4. templates/commands/build.md
  5. templates/commands/plan.md
  6. templates/commands/quick.md
  7. templates/commands/status.md
  8. templates/commands/tasks.md

Errors to Fix

Based on the failing job logs from https://github.com/deyil/spec-kit/actions/runs/21511414142/job/61979097123, fix all the following markdownlint rule violations:

docs/quickstart.md

  • Line 75: MD030 - List markers should have 1 space, not 2
  • Line 76: MD031 - Fenced code blocks should be surrounded by blank lines
  • Line 80: MD030 - List markers should have 1 space, not 2
  • Line 81: MD031 - Fenced code blocks should be surrounded by blank lines
  • Line 85: MD030 - List markers should have 1 space, not 2
  • Line 86: MD031 - Fenced code blocks should be surrounded by blank lines
  • Line 90: MD030 - List markers should have 1 space, not 2
  • Line 91: MD031 - Fenced code blocks should be surrounded by blank lines
  • Line 95: MD030 - List markers should have 1 space, not 2
  • Line 96: MD031 - Fenced code blocks should be surrounded by blank lines

README.md

  • Line 97: MD022 - Heading should have blank line below
  • Line 105: MD022 - Heading should have blank line below
  • Line 113: MD022 - Heading should have blank line below
  • Line 281: MD032 - Lists should be surrounded by blank lines

spec-driven.md

  • Line 79: MD022 - Heading should have blank line below
  • Line 82: MD022 - Heading should have blank line below
  • Line 85: MD022 - Heading should have blank line below

templates/commands/build.md

  • Line 156: MD031 - Fenced code blocks should be surrounded by blank lines
  • Line 168: MD009 - Trailing spaces (Expected: 0 or 2; Actual: 3)
  • Line 170: MD031 - Fenced code blocks should be surrounded by blank lines
  • Line 182: MD009 - Trailing spaces (Expected: 0 or 2; Actual: 3)
  • Line 188: MD009 - Trailing spaces (Expected: 0 or 2; Actual: 3)
  • Line 199: MD009 - Trailing spaces (Expected: 0 or 2; Actual: 3)
  • Line 220: MD009 - Trailing spaces (Expected: 0 or 2; Actual: 3)
  • Line 225: MD031 - Fenced code blocks should be surrounded by blank lines
  • Line 244: MD009 - Trailing spaces (Expected: 0 or 2; Actual: 3)
  • Line 246: MD009 - Trailing spaces (Expected: 0 or 2; Actual: 3)
  • Line 252: MD009 - Trailing spaces (Expected: 0 or 2; Actual: 3)
  • Line 254, position 44: MD009 - Trailing spaces (Expected: 0 or 2; Actual: 1)
  • Line 260: MD009 - Trailing spaces (Expected: 0 or 2; Actual: 3)
  • Line 262: MD031 - Fenced code blocks should be surrounded by blank lines
  • Line 274: MD031 - Fenced code blocks should be surrounded by blank lines
  • Line 317: MD029 - Ordered list item prefix (Expected: 1; Actual: 5)
  • Line 318: MD031 - Fenced code blocks should be surrounded by blank lines
  • Line 355: MD029 - Ordered list item prefix (Expected: 1; Actual: 6)
  • Line 356: MD031 - Fenced code blocks should be surrounded by blank lines
  • Line 383: MD029 - Ordered list item prefix (Expected: 1; Actual: 7)
  • Line 384: MD031 - Fenced code blocks should be surrounded by blank lines
  • Line 417: MD009 - Trailing spaces (Expected: 0 or 2; Actual: 3)
  • Line 419: MD009 - Trailing spaces (Expected: 0 or 2; Actual: 3)
  • Line 424: MD009 - Trailing spaces (Expected: 0 or 2; Actual: 3)
  • Line 430: MD009 - Trailing spaces (Expected: 0 or 2; Actual: 3)
  • Line 437: MD009 - Trailing spaces (Expected: 0 or 2; Actual: 3)
  • Line 439: MD031 - Fenced code blocks should be surrounded by blank lines
  • Line 458: MD009 - Trailing spaces (Expected: 0 or 2; Actual: 3)
  • Line 460: MD031 - Fenced code blocks should be surrounded by blank lines
  • Line 478: MD031 - Fenced code blocks should be surrounded by blank lines
  • Line 505: MD031 - Fenced code blocks should be surrounded by blank lines
  • Line 551: MD012 - Multiple consecutive blank lines (Expected: 1; Actual: 2)

templates/commands/plan.md

  • Line 73, position 101: MD009 - Trailing spaces (Expected: 0 or 2; Actual: 1)

templates/commands/quick.md

  • Line 39: MD032 - Lists should be surrounded by blank lines
  • Line 133: MD031 - Fenced code blocks should be surrounded by blank lines
  • Line 167: MD009 - Trailing spaces (Expected: 0 or 2; Actual: 3)
  • Line 179: MD031 - Fenced code blocks should be surrounded by blank lines
  • Line 198: MD032 - Lists should be surrounded by blank lines
  • Line 208: MD032 - Lists should be surrounded by blank lines
  • Line 217: MD032 - Lists should be surrounded by blank lines
  • Line 223: MD009 - Trailing spaces (Expected: 0 or 2; Actual: 3)
  • Line 225: MD009 - Trailing spaces (Expected: 0 or 2; Actual: 3)
  • Line 230: MD009 - Trailing spaces (Expected: 0 or 2; Actual: 3)
  • Line 250: MD032 - Lists should be surrounded by blank lines
  • Line 258: MD032 - Lists should be surrou...

This pull request was created from Copilot chat.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@deyil
deyil marked this pull request as ready for review January 30, 2026 09:48
Co-authored-by: deyil <872880+deyil@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix markdownlint errors in several markdown files Fix markdownlint errors causing CI failures Jan 30, 2026
Copilot AI requested a review from deyil January 30, 2026 10:04
@deyil

deyil commented Jan 30, 2026

Copy link
Copy Markdown
Owner

@copilot please fix 1 failing check and update this PR.

Co-authored-by: deyil <872880+deyil@users.noreply.github.com>

Copilot AI commented Jan 30, 2026

Copy link
Copy Markdown
Author

@copilot please fix 1 failing check and update this PR.

Fixed the failing markdownlint check in docs/installation.md. Added blank lines after headings and around lists to resolve MD022 and MD032 violations. Commit: a17df21

@deyil
deyil merged commit 22b9755 into main Jan 30, 2026
1 check passed
@deyil
deyil deleted the copilot/fix-markdownlint-errors branch January 30, 2026 10:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants