From 879b50199fe55d1044c33e566d6a6b767f97aaa8 Mon Sep 17 00:00:00 2001 From: Abhimanyu Saharan Date: Thu, 12 Feb 2026 09:05:48 +0000 Subject: [PATCH] ci(docs): scope link check to docs/ only (avoid legacy README links) --- scripts/check_markdown_links.py | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/scripts/check_markdown_links.py b/scripts/check_markdown_links.py index cca1accd..e32c7f1c 100755 --- a/scripts/check_markdown_links.py +++ b/scripts/check_markdown_links.py @@ -25,18 +25,20 @@ LINK_RE = re.compile(r"\[[^\]]+\]\(([^)]+)\)") def iter_md_files(root: Path) -> list[Path]: - patterns = [ - root / "README.md", - root / "CONTRIBUTING.md", - ] - files: list[Path] = [] - for p in patterns: - if p.exists(): - files.append(p) + """Return markdown files to check. + + Policy (initial): check only `docs/**/*.md`. + + Rationale: + - Root `README.md` / `CONTRIBUTING.md` may temporarily contain legacy links + during docs re-org. Once docs + README are stabilized, we can expand this + to include root markdown files. + """ + docs = root / "docs" - if docs.exists(): - files.extend(sorted(docs.rglob("*.md"))) - return files + if not docs.exists(): + return [] + return sorted(docs.rglob("*.md")) def normalize_target(raw: str) -> str | None: