Fix markdownlint: disable MD060 (conflicts with prettier), fix stray MD001#5121
Merged
Merged
Conversation
…ng skip MD060/table-column-style is a newer default rule in markdownlint that conflicts with prettier's table formatting. prettier is the repo's canonical formatter and its CI check already passes on the 13 affected files, so enforcing MD060 would fight it. Disable MD060, consistent with the other prettier-driven rule exclusions already in .markdownlint.yaml (MD030, etc.). Also promote the "Microstepping and speed math" heading in gpiostepper.md from h3 to h2, fixing the one non-MD060 failure (MD001 heading-increment) and making it a peer of the sibling "Wiring example" h2 section. With both changes, markdownlint runs clean across docs/.
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
viambot
added
the
safe to build
Nick Hehr (HipsterBrown)
approved these changes
Jul 1, 2026
|
🔎💬 Inkeep AI search and chat service is syncing content for source 'Viam Docs' |
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
3 participants
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.
What
Fix the repo-wide
Check Markdown files(markdownlint) failure by disabling MD060/table-column-style, and fix the one unrelated MD001 heading error.Why this started failing (no docs changed)
MD060/table-column-stylewas added in markdownlint v0.39.0 (2025-10-13) and ships enabled by default..markdownlint.yamlstarts withdefault: true, so a newly added rule turns on automatically unless explicitly disabled.ruzickap/action-my-markdown-linter@v1(a floating tag; its bundledmarkdownlint-cliis renovate-bumped to 0.49.0 → markdownlint lib with MD060). When that version landed, the rule activated against tables that had been unchanged for months.Result: 49 MD060 violations across 13 files appeared with zero content changes, failing on whatever PR ran CI next (e.g. #5116, #5118) even though those PRs never touched the affected files.
The fix
.markdownlint.yaml: addMD060: false, consistent with the existing prettier-driven rule exclusions (MD030, MD013, MD046, …). prettier stays the canonical table formatter.docs/reference/components/motor/gpiostepper.md: promote### Microstepping and speed math→##(peer of the sibling## Wiring example), fixing the loneMD001/heading-incrementerror. The heading text — and its anchor — are unchanged, so no links break.Verification
markdownlint-cli@latest --config .markdownlint.yaml "docs/**/*.md"→ 0 errors (was 50).prettier --checkstill passes on the edited file.Note
The
Check Markdown filesjob iscontinue-on-error: true, so it was non-blocking by design — this makes it green rather than perma-red. Pinning theruzickap/...@v1action to a SHA later would prevent the next surprise-rule bump; disabling MD060 explicitly is robust regardless.