Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

[MAINTENANCE] Run docs-check in CI so docs-site regressions are caught before release #561

Copy link
Copy link
@WadydX

Description

@WadydX
Issue body actions

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

  1. Inspect Makefile and note that docs-check exists and validates the generated docs site.
  2. Inspect the CI workflow at .github/workflows/ci.yml.
  3. 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-check
    • make test
    • make 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

Reactions are currently unavailable

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      Morty Proxy This is a proxified and sanitized view of the page, visit original site.