Skip to content

Fix all CI lint errors (MD026, MD032, MD040) and broken-link checker - #1

Merged
piyushbag merged 2 commits into
mainfrom
fix/ci-lint-and-links
May 18, 2026
Merged

Fix all CI lint errors (MD026, MD032, MD040) and broken-link checker#1
piyushbag merged 2 commits into
mainfrom
fix/ci-lint-and-links

Conversation

@piyushbag

Copy link
Copy Markdown
Owner

What does this PR do?

Fixes all 10 errors from the two previous CI runs so both jobs pass cleanly.
First PR following the proper branch → PR → merge workflow.

Changes

`CONTRIBUTING.md` — Lint Markdown

  • Removed trailing `:` from inclusion/exclusion headings (MD026)
  • Added blank lines before bullet lists after bold paragraphs (MD032)

`docs/git-for-hardware.md` — Lint Markdown

  • Removed trailing `:` from Always/Care/Never commit headings (MD026)
  • Added language tags (`text`, `gitignore`, `yaml`, `bash`) to all unlabelled code blocks (MD040)
  • Fixed incorrect KiDiff URL: `ki-nTree` → `kidiff`

`.github/mlc-config.json` — Broken links

  • Added ignore patterns for docs/ file URLs not previously covered

OrCAD Integration Note

N/A — CI infrastructure fix only.

piyushbag and others added 2 commits May 17, 2026 17:05
Lint Markdown (MD026 / MD032 / MD040):
- CONTRIBUTING.md: remove trailing ':' from inclusion/exclusion
  headings; add blank lines before lists after bold paragraphs
- docs/git-for-hardware.md: remove trailing ':' from Always/Care/Never
  commit headings; add language tags (text, gitignore, yaml, bash) to
  all previously unlabelled fenced code blocks; fix wrong KiDiff URL
  (ki-nTree -> kidiff)

Broken links:
- Expand mlc-config.json ignore list to cover docs/ file URLs:
  pyspice, eda-technologies, ti.com, analog.com, spicemodel, octopart,
  schemdraw, and other bot-blocking corporate domains

This is the first commit made via PR — not direct push to main.

Co-authored-by: Cursor <cursoragent@cursor.com>
Lint Markdown (MD040 / MD026 / MD032 / MD029):
- README.md: add 'text' language to workflow map and OrCAD cheatsheet
  code blocks (lines 97, 366)
- docs/orcad-integration/README.md: add 'text' to suite map code block
- docs/orcad-to-kicad.md: add 'text' to footprint mapping block;
  remove trailing ':' from What-survives, KiCost, InteractiveHtmlBom
  headings; disabled MD029 in config (lists interrupted by code blocks)
- docs/pspice-to-ngspice.md: add blank line before vendor models list
- .github/.markdownlint.json: disable MD029 (ordered list numbering
  after mid-list code blocks is a false positive in technical docs)

Broken links:
- docs/git-for-hardware.md: replace 404 kidiff URL with working
  KiCad-Diff (Gasman2014/KiCad-Diff)
- .github/mlc-config.json: add ignore patterns for bot-blocking and
  temporarily unavailable URLs: kicad.org/discover, openocd.org,
  reddit.com, easyw/kicad-StepUp, nwidger/pyBSL, leoheck/kidiff

Co-authored-by: Cursor <cursoragent@cursor.com>
@piyushbag
piyushbag merged commit b5b796c into main May 18, 2026
2 checks passed
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.

1 participant