Skip to content

docs: enforce API documentation coverage - #3949

Open
SomSamantray wants to merge 12 commits into
apify:masterfrom
SomSamantray:docs/api-documentation-coverage
Open

docs: enforce API documentation coverage#3949
SomSamantray wants to merge 12 commits into
apify:masterfrom
SomSamantray:docs/api-documentation-coverage

Conversation

@SomSamantray

Copy link
Copy Markdown

Summary

API documentation coverage is now enforced as a deterministic, package-aware build gate.

  • Adds TypeDoc coverage analysis with a committed baseline ratchet that fails closed on missing packages, undocumented symbols, malformed input, and public API surface changes.
  • Documents shared types, storage, autoscaling, and browser-controller APIs while repairing affected logging links.
  • Adds focused regression coverage for inherited documentation, generated-data failures, and reflection replacements.

Validation

  • yarn vitest run test/api-documentation-coverage.test.mts — 9 passed
  • yarn tsc-check-tests
  • yarn lint
  • yarn format:check
  • Website build — 1989/2812 reflections covered (70.7%)

New 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

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.

2 participants