https://api-extractor.com/pages/overview/intro/

1. Generate API reports (Markdown format) for all distributable plugin SDK packages. Add API reports to version control and update the build process to compare the currently generated files with ones committed in the version control.

API reports are meant to improve the visibility of public APIs exposed by the given package and track public API changes through code review process. These reports are aimed at plugin SDK maintainers to better understand the impact of changes on public APIs.

2. Generate API docs metadata (JSON format) for all distributable plugin SDK packages. As a follow-up, these files will be used to generate public API docs in Markdown format. These API docs can then be published via e.g. GitHub pages or similar service.

API docs are meant to document public APIs of the given package (various objects, functions, React components, etc.) from plugin SDK consumer perspective. In other words, these docs are aimed at developers of dynamic plugins as well as developers of host applications that support such plugins.