CI: markdownlint should cover nested repo Markdown #140

New issue

Closed

opened 2026-04-19 19:07:28 +00:00 by pokebedrock-bot · 1 comment

pokebedrock-bot commented

2026-04-19 19:07:28 +00:00

(Migrated from github.com)

Summary

npm run lint:md only covers docs/**/*.{md,mdx} and root *.md, so nested repo Markdown like assets/README.md and .github templates can drift without any CI signal.

Evidence

Current script on main: markdownlint-cli2 "docs/**/*.{md,mdx}" "*.md"
Local repro on fresh main:
1. Append an extra H1 to assets/README.md
2. Run npm run lint:md
3. The command still exits 0 and reports Linting: 40 file(s)
Expanding the glob locally to include .github/**/*.md and assets/**/*.md immediately catches existing Markdown formatting drift in assets/README.md (MD047 missing trailing newline), proving the current CI scope is incomplete.

Impact

Contributor-facing docs outside docs/ can regress in formatting/style with no PR-time feedback, which makes repo guidance inconsistent and lets small stale-content issues slip through review.

Acceptance criteria

npm run lint:md covers nested repository Markdown outside docs/, including at least .github/**/*.md and assets/**/*.md
Existing tracked Markdown in the widened scope passes markdownlint
npm run ci stays green after the lint-scope expansion

## Summary `npm run lint:md` only covers `docs/**/*.{md,mdx}` and root `*.md`, so nested repo Markdown like `assets/README.md` and `.github` templates can drift without any CI signal. ## Evidence - Current script on `main`: `markdownlint-cli2 "docs/**/*.{md,mdx}" "*.md"` - Local repro on fresh `main`: 1. Append an extra H1 to `assets/README.md` 2. Run `npm run lint:md` 3. The command still exits 0 and reports `Linting: 40 file(s)` - Expanding the glob locally to include `.github/**/*.md` and `assets/**/*.md` immediately catches existing Markdown formatting drift in `assets/README.md` (`MD047` missing trailing newline), proving the current CI scope is incomplete. ## Impact Contributor-facing docs outside `docs/` can regress in formatting/style with no PR-time feedback, which makes repo guidance inconsistent and lets small stale-content issues slip through review. ## Acceptance criteria - `npm run lint:md` covers nested repository Markdown outside `docs/`, including at least `.github/**/*.md` and `assets/**/*.md` - Existing tracked Markdown in the widened scope passes markdownlint - `npm run ci` stays green after the lint-scope expansion

smell-of-curry commented

2026-10-06 16:04:06 +00:00

Owner

Already fixed on main by 9abfb67 (PR #141). package.json lint:md is markdownlint-cli2 "docs/**/*.{md,mdx}" ".github/**/*.md" "assets/**/*.md" "*.md". A local run on f005e79 lints 72 files with 0 errors.

Already fixed on `main` by `9abfb67` (PR #141). `package.json` `lint:md` is `markdownlint-cli2 "docs/**/*.{md,mdx}" ".github/**/*.md" "assets/**/*.md" "*.md"`. A local run on `f005e79` lints 72 files with 0 errors.

smell-of-curry closed this issue

2026-10-06 16:04:06 +00:00