docs: deterministic API reference + docs-check CI gate (Phase A) - #1
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.
make docs/npm run docs) via TypeDoc + typedoc-plugin-markdown, reading public exports + JSDoc into committeddocs/api/.docs-checkgate (make docs-check/npm run docs:check) that regenerates and fails on drift, checks internal links, and compiles README ts snippets.docs-checkCI job wired intoci.yml(Node 22.x), runnable as a required PR check. The existingtestmatrix andpermissionsare unchanged.Verification
make docsre-generation byte-identical (deterministic); no timestamps/abs-paths/host info.npm run docs:check: PASS on clean tree; JSDoc drift → non-zero (reverse-verified).npm ci+ build + docs:check on Node 22.x): PASS.Scope / out of scope
examples-smoke+ examples/tests decoupling (tracked separately) due to a circular examples↔tests dependency.