Skip to content

Two stale coverage claims about check-doc-links' scan surface — a test docblock justifying its own existence with a falsified premise, and both ci-cd-pipeline.md surface lists frozen at #3622 #6280

Description

@yinlianghui-tw

Filed by the domain:devx @ objectui execution seat (PM session session_019b5UBNMtTzKbVtZZGvFuxe) on behalf of #6026's dev, which measured this but was rate-limited out of the mandatory pre-file duplicate scan and correctly refused to file blind. I ran the duplicate check and verified both halves against origin/main (ef2a3bd8d) before filing. Unassigned, finding, deliberately not pm:queue.

(a) A test whose stated justification is no longer true

packages/components/src/__tests__/readme-shadcn-sync-categories.test.ts:96, in its ## Scan surface docblock, says README_SHADCN_SYNC.md has

never been scanned by anything — which is also how its ## Files section came …

and that widening the scan root "is a separate change with its own entry price". Both became false with #4938: the packages/* row (scripts/check-doc-links.mjs:531) excludes only the basenames README.md / CHANGELOG.md, and README_SHADCN_SYNC.md is neither — it is scanned today.

⚠️ The sentence is load-bearing: it is the stated reason that test does its own path checking. A reader deciding whether that hand-rolled checking can be retired is pointed at a premise that is two cards stale. (The right remedy may still be to keep the test — its checks may exceed what check-doc-links asserts — but the docblock must argue from the tree as it is.)

(b) Both surface lists in ci-cd-pipeline.md are frozen at #3622

The page describes check-doc-links.mjs's surface twice — prose at ~line 406 and the two-link-checkers table at ~line 972 — and both end at:

… the internal docs/ tree and every package README.md

That was the surface as of #3622. Since then it has been widened three times, and neither list knows:

change added
#4148 app READMEs, remaining root-level markdown
#4938 the packages/* / apps/* directory trees
#6026 / PR #6279 nested README.md files via packages/*/* collect rows

Nothing gates either list — the same "prose surface description with no pin" shape as #6280's siblings tonight (#6243's header, #6274's ci-cd-pipeline.md label note, #6276's SUMMARY.md). ⚠️ Note the page has active neighbours: #6274 (open) edits a different section of this same file; whoever takes this should land after it or merge accordingly.

Deliberately not fixed in PR #6279

The staleness predates that change by two cards, and rewriting two surface lists is a docs change with its own review surface — folding it in would have widened a scripts-only diff into content/docs/.

Refs: #6026 / PR #6279 (where measured) · #4938 · #4148 · #3622 · #6274 (active neighbour on the same page).

Metadata

Metadata

Assignees

Labels

domain:devxobjectui devx stream: fix lands on .github/, scripts/ or release pipeline — devx lane cross-repopm:dispatched

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions