fix: resolve markdownlint errors across documentation#1571
fix: resolve markdownlint errors across documentation#1571mnriem merged 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 <[email protected]>
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.
There was a problem hiding this comment.
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]>
….0.98) Key upstream changes absorbed: - Modular extension system (PR github#1551): plugin architecture with YAML manifests, extension catalog, hook system, CLI management commands - Constitution preservation on reinit (PR github#1553): template moved to templates/constitution-template.md, user customizations preserved - .specify.specify path bug fix (PR github#1588): double-nesting resolved - Google Anti Gravity agent support (PR github#1220): new agy agent in release - Stale workflow (PR github#1594): auto-close inactive issues after 180 days - Dependabot config (PR github#1622): automated pip and Actions updates - Markdownlint fixes (PR github#1571), plan template typo (PR github#1446) - README maintainers section removed (PR github#1618) Conflict resolutions: - pyproject.toml: kept our version (0.0.20.post1) over upstream 0.1.0 - plan-template.md: kept /sp.plan prefix over upstream /speckit.plan - create-release-packages.sh: merged agy agent + kept our generate_agent_rules; updated constitutionplus/command-rules paths from memory/ to templates/ to match upstream rename - README.md: kept our SpecifyPlus content, dropped upstream maintainers section (already removed upstream), preserved contributing section - templates/command-rules.md, templates/constitutionplus.md: accepted memory/ → templates/ relocation matching upstream convention Co-Authored-By: Claude Opus 4.6 <[email protected]>
* fix: resolve markdownlint errors across documentation (github#1571) - 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]> * fix: preserve constitution.md during reinitialization (github#1541) (github#1553) Moves constitution template from memory/ to templates/ to prevent overwrites when spec-kit is reinitialized with a different AI agent. Changes: - Move memory/constitution.md to templates/constitution-template.md - Update CLI to copy template to memory/ only on first initialization - Update constitution command to reference correct paths with .specify/ prefix - Preserve existing constitution.md when reinitializing project The CLI now checks if .specify/memory/constitution.md exists: - If it exists: preserve it (no overwrite) - If it doesn't exist: copy from .specify/templates/constitution-template.md This allows users to customize their constitution without losing changes when adding support for additional AI agents or reinitializing. Fixes github#1541 Co-authored-by: jjoung1128 <[email protected]> Co-authored-by: Claude Sonnet 4.5 <[email protected]> * Merge commit '4afbd87abb45744966bbeaaa71d20742cf778c48' into chore/merge-upstream-v0.0.91
Summary
Test plan
npx markdownlint-cli2 "**/*.md"- passes with 0 errors🤖 Generated with Claude Code