Description
The repository defines a docs validation gate (make docs-check) that builds the docs site and validates links, but the main CI workflow never runs it. That leaves docs-site and repo-link regressions undetected until someone notices them manually.
This is currently observable in the repo: several user-facing docs/template surfaces still reference the old steipete/gogcli owner even though the repository now lives at openclaw/gogcli.
Steps to Reproduce
- Inspect
Makefile and note that docs-check exists and validates the generated docs site.
- Inspect the CI workflow at
.github/workflows/ci.yml.
- Compare the
ci target and workflow steps with current docs/public-facing files.
Expected Behavior
CI should run the docs validation gate so broken generated-doc links or stale repository references are caught before merge/release.
Actual Behavior
The CI workflow runs format/test/lint/build-related checks, but does not run make docs-check, so docs-site regressions can ship unnoticed.
Environment
- Version:
main as of 2026-05-05
- OS: static analysis only
- Installation method: repository inspection
Logs / Evidence
Relevant current evidence:
Makefile defines:
docs-check: docs-site@node scripts/check-docs-coverage.mjs
Makefile defines ci as:
ci: pnpm-gate fmt-check lint test
.github/workflows/ci.yml runs:
make fmt-checkmake testmake lint- but not
make docs-check
Current stale-reference examples that this class of check should help catch:
scripts/build-docs-site.mjs sets repoBase = "https://github.com/steipete/gogcli"README.md still points at https://github.com/steipete/gogcli/...docs/install.md still points at https://github.com/steipete/gogcli/...internal/googleauth/templates/accounts.html still links to https://github.com/steipete/gogcli...internal/googleauth/templates/success.html still links to https://github.com/steipete/gogcli
Additional Context
Description
The repository defines a docs validation gate (
make docs-check) that builds the docs site and validates links, but the main CI workflow never runs it. That leaves docs-site and repo-link regressions undetected until someone notices them manually.This is currently observable in the repo: several user-facing docs/template surfaces still reference the old
steipete/gogcliowner even though the repository now lives atopenclaw/gogcli.Steps to Reproduce
Makefileand note thatdocs-checkexists and validates the generated docs site..github/workflows/ci.yml.citarget and workflow steps with current docs/public-facing files.Expected Behavior
CI should run the docs validation gate so broken generated-doc links or stale repository references are caught before merge/release.
Actual Behavior
The CI workflow runs format/test/lint/build-related checks, but does not run
make docs-check, so docs-site regressions can ship unnoticed.Environment
mainas of 2026-05-05Logs / Evidence
Relevant current evidence:
Makefiledefines:docs-check: docs-site@node scripts/check-docs-coverage.mjsMakefiledefinescias:ci: pnpm-gate fmt-check lint test.github/workflows/ci.ymlruns:make fmt-checkmake testmake lintmake docs-checkCurrent stale-reference examples that this class of check should help catch:
scripts/build-docs-site.mjssetsrepoBase = "https://github.com/steipete/gogcli"README.mdstill points athttps://github.com/steipete/gogcli/...docs/install.mdstill points athttps://github.com/steipete/gogcli/...internal/googleauth/templates/accounts.htmlstill links tohttps://github.com/steipete/gogcli...internal/googleauth/templates/success.htmlstill links tohttps://github.com/steipete/gogcliAdditional Context
docs-checkalone would catch every stale string in the repo, but the current CI gap makes docs/public-surface drift easier to miss.make docs-checkin CI seems like the minimal starting point.