Skip to content

[Bounty: $75] Build the typedoc API docs in CI #435

Description

@Abbyhay

Context

package.json exposes a docs script that runs typedoc over six entrypoints with tsconfig.docs.json, and the generated output under docs/api/ is committed, but none of the seven workflows under .github/workflows/ run npm run docs. A PR that breaks typedoc or removes a documented export can land on main unnoticed.

Proposed Change

Add a docs build job (or extend the existing ci.yml matrix) that runs npm run build then npm run docs, fails on typedoc errors, and fails on a git diff if generated artifacts are committed.

Acceptance Criteria

  • The job runs typedoc on every PR
  • A change that makes typedoc fail (e.g. a broken doc reference) fails CI
  • The committed docs/api/ output stays consistent with the build

Suggested Label

ci

ETA: 24 hours

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions