Skip to content

test: correct root-docs-links' account of what check:links does #1138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mrbobbytables merged 1 commit into from
Oct 7, 2026
Merged

test: correct root-docs-links' account of what check:links does #1138

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions tests/root-docs-links.test.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,14 @@ import { dirname, join, relative, resolve } from 'node:path';
const repoRoot = resolve(dirname(new URL(import.meta.url).pathname), '..');

// Root-level *.md are the contributor-facing entry points. They are not part
// of the Docusaurus route tree, so `onBrokenMarkdownLinks` never reads them,
// and `npm run check:links` delegates to a Makefile that does not exist.
// Nothing else verifies that their relative links still resolve.
// of the Docusaurus route tree, so `onBrokenMarkdownLinks` never reads them.
//
// `npm run check:links` does work -- it shells out to markdown-link-check with
// .markdown-link-check.json, which tests/markdown-link-check-config.test.mjs
// guards -- but no workflow invokes it, so it never runs on a change (#1137).
// It also checks outbound http(s) URLs rather than relative paths, which is
// the complementary half: these cases resolve targets on disk and issue no
// request. Nothing else verifies that their relative links still resolve.
const ROOT_DOCS = readdirSync(repoRoot)
.filter((name) => name.endsWith('.md'))
.sort();
Expand Down
Loading