docs: enforce API documentation coverage - #3949
Open
SomSamantray wants to merge 12 commits into
Open
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.
Summary
API documentation coverage is now enforced as a deterministic, package-aware build gate.
Validation
yarn vitest run test/api-documentation-coverage.test.mts— 9 passedyarn tsc-check-testsyarn lintyarn format:checkNew concepts
A baseline ratchet treats generated API reflection keys as a compatibility surface: coverage can improve, but public symbols cannot silently disappear or be replaced. This is useful when generated documentation is the source of truth; it is unnecessary for purely hand-authored docs.
Related: #3884