Skip to content

docs/ci: docs pipeline is wired into CI and Pages, but docs scripts are missing from package.json #299

@sauravpanda

Description

@sauravpanda

Summary

The repository has a VitePress docs site and GitHub Actions workflows that try to build it, but the actual docs:* package scripts are missing, so the documented docs workflow cannot run.

Evidence

  • package.json only defines dev, build, preview, lint, lint:fix, format, format:check, typecheck, and tauri.
  • .github/workflows/ci.yml runs pnpm docs:build in the frontend checks job.
  • .github/workflows/docs.yml also runs pnpm docs:build before uploading docs/.vitepress/dist.
  • README.md and docs/guide/getting-started.md tell contributors to run pnpm docs:dev, pnpm docs:build, and pnpm docs:preview.
  • Local validation currently fails with ERR_PNPM_RECURSIVE_EXEC_FIRST_FAIL Command "docs:build" not found.

Impact

  • The GitHub Pages docs workflow is broken as written.
  • Frontend CI can fail on the missing docs command.
  • Contributors are sent down a documented path that does not exist.

Suggested fix

  • Add the VitePress dependency and define docs:dev, docs:build, and docs:preview in package.json.
  • Keep the README, docs guides, and workflows aligned with the real script surface.
  • Consider validating documented commands against package.json in CI so this does not drift again.

Acceptance criteria

  • pnpm docs:build succeeds locally.
  • The docs workflow can publish docs/.vitepress/dist.
  • Repository docs only mention commands that actually exist.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions