repo-website-api-update

API documentation synchronization validates updated function signatures, interfaces, and JSDoc comments against the actual source code implementation. This enforces alignment between source files and website references to prevent documentation drift.

You need to update API docs after modifying library code whenever core packages undergo function signature changes, interface updates, or JSDoc edits. Running the synchronization workflow refreshes API pages and examples to reflect the current implementation accurately.

Aligning JSDoc comments with updated function signatures requires a validation process that checks signatures, types, and descriptions across all API reference sections. An impact analysis identifies affected doc sections to guide targeted updates across core packages and website docs.

Yes, documentation synchronization covers all API reference sections and associated examples. By validating signatures and types, the workflow ensures that both the descriptive text and code examples reflect the current source implementation.

To identify which documentation sections need updates after a code change, perform an impact analysis on the modified core packages. This analysis guides targeted updates by locating all API references and examples affected by the signature or interface modifications.