Skip to content

docs: deterministic API reference + docs-check CI gate (Phase A) - #1

Merged
moonyue-w merged 3 commits into
mainfrom
1789716378-ts-sdk-docs-ci-pilot
Sep 18, 2026
Merged

moonyue-w merged 3 commits into
mainfrom
1789716378-ts-sdk-docs-ci-pilot

Conversation

@moonyue-w

Copy link
Copy Markdown
Collaborator

What

Phase A of the SDK repository-management effort: a documentation gate for the TS SDK. No release signing, no examples-smoke (deferred), no runtime changes.

  1. Deterministic API reference generation (make docs / npm run docs) via TypeDoc + typedoc-plugin-markdown, reading public exports + JSDoc into committed docs/api/.
  2. A docs-check gate (make docs-check / npm run docs:check) that regenerates and fails on drift, checks internal links, and compiles README ts snippets.
  3. A docs-check CI job wired into ci.yml (Node 22.x), runnable as a required PR check. The existing test matrix and permissions are unchanged.

Verification

  • make docs re-generation byte-identical (deterministic); no timestamps/abs-paths/host info.
  • npm run docs:check: PASS on clean tree; JSDoc drift → non-zero (reverse-verified).
  • Full suite: 3333/3333 pass.
  • Clean-room reproduction (fresh clone + npm ci + build + docs:check on Node 22.x): PASS.

Scope / out of scope

  • Deferred: examples-smoke + examples/tests decoupling (tracked separately) due to a circular examples↔tests dependency.
  • Remote branch-protection / required-checks config is documented, not applied here.

@moonyue-w
moonyue-w merged commit 2e223e5 into main Sep 18, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant