Skip to content

finding(docs): ci-cd-pipeline.md publishes the same two hand-copied doc counts #7825 just removed from check-links.yml's header #7886

Description

@claude

Found while fixing objectui#7825 (check-links.yml's header carried two hand-copied document counts that had drifted). The same two counts live, present tense, on a published page, outside that card's binding file surface — so recorded here rather than fixed there.

What

content/docs/guide/ci-cd-pipeline.md, in the Link Checking (check-links.yml) section:

Lychee sweeps both documentation trees: content/docs/ (the 183 pages the site publishes) and the repo-root docs/ (15 files of internal material — ADRs, audits, architecture notes) plus README.md.

claim page says measured on 83fe6e741
content/docs/** markdown 183 184
repo-root docs/** markdown 15 17

Measured with the same walk check-links.yml's args block declares:

find docs -type f \( -name '*.md' -o -name '*.mdx' \) | wc -l          # 17
find content/docs -type f \( -name '*.md' -o -name '*.mdx' \) | wc -l   # 184

check:shell-escape-residue's own verdict line corroborates the second reading independently — it walks the same tree and reports content/docs: 184 file(s).

Why it is worth recording

Third and fourth instance of the objectui#7448 class, and the worst-placed pair of the four: the other copies were comments read by contributors, this one is prose the site publishes to readers. Nothing fails on a stale number written in a comment — and still less on one written in a doc page, since no gate reads these two figures at all.

The remedy is already landed three times in this repository (objectui#7448 twice, objectui#7825 once): state the population, and point at the reading, instead of copying a count. check-doc-snippet-types.mjs's UNGATED_DOCS header records the original wording — "a pointer to the list now rather than a copy of its length". Rewritten that way, the sentence would read something like "both documentation trees: the published content/docs/ and the repo-root docs/ of internal material, plus README.md" — which is the whole informational content of the sentence, with neither number.

Not a defect in any gate

The scan scope is decided by check-links.yml's args glob list. No verdict anywhere depends on either figure. This is prose accuracy only, which is why it is filed finding rather than queued.

Note for whoever picks it up

objectui#3653 pins this page's job table by command, and this change adds and removes no ci command, so no table row is involved. But the page is under content/docs/**, so the edit is in the doc-gate family's surface — check:doc-types, check:doc-snippets, check:doc-fences and check-doc-links.mjs all read it. That is precisely why objectui#7825 did not take it as a rider: it would have widened a two-file prose PR into the whole doc-gate verification face.

Back-links: objectui#7825, objectui#7448.


Generated by Claude Code

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationdomain:devxobjectui devx stream: fix lands on .github/, scripts/ or release pipeline — devx lane cross-repofindingpm:dispatchedpriority:p3

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions