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
Suggested Label
ci
ETA: 24 hours
Context
package.jsonexposes adocsscript that runs typedoc over six entrypoints withtsconfig.docs.json, and the generated output underdocs/api/is committed, but none of the seven workflows under.github/workflows/runnpm run docs. A PR that breaks typedoc or removes a documented export can land onmainunnoticed.Proposed Change
Add a docs build job (or extend the existing
ci.ymlmatrix) that runsnpm run buildthennpm run docs, fails on typedoc errors, and fails on a git diff if generated artifacts are committed.Acceptance Criteria
docs/api/output stays consistent with the buildSuggested Label
ci
ETA: 24 hours