-
Notifications
You must be signed in to change notification settings - Fork 6k
fix: resolve markdownlint errors across documentation #1571
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
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 <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@amuzip Thank you! |
…eservation Synced with github/spec-kit upstream (v0.0.93). Brings in: - Modular extension system (github#1551) - Fix .specify path error (github#1588) - Preserve constitution.md during reinitialization (github#1553) - Markdown lint fixes (github#1571) Resolved pyproject.toml conflict: kept Trimble naming/version while accepting upstream's new dependencies (pyyaml, packaging) and test config. All Trimble-specific changes preserved: - Modus Docs MCP integration in plan.md, implement.md, plan-template.md - MCP configs (mcp-standard.json, mcp-vscode.json) - Modus MCP handler in __init__.py - PyPI publishing workflow and README Co-authored-by: Cursor <[email protected]>
Summary
Test plan
npx markdownlint-cli2 "**/*.md"- passes with 0 errors🤖 Generated with Claude Code