Create scripting to generate a markdown file that we can commit in the repository and display on GitHub to provide documentation on the APIs (hooks and components) and the extensions and other TypeScript types that are part of the public API.

This should be similar to the documentation that is available for the OpenShift console dynamic plugin SDK. See:
https://github.com/openshift/console/blob/main/frontend/packages/console-dynamic-plugin-sdk/docs/api.md
https://github.com/openshift/console/blob/main/frontend/packages/console-dynamic-plugin-sdk/docs/console-extensions.md

Some improvements compared to the OpenShift documentation that would be nice to have would be:

• Better organized index - just alphabetically sorted would be fine
• More details on types of parameters and return types

The documentation should be based on JSDoc or TSDoc or similar, that lives in comments in the code and integrates with IDEs so that we can easily view this information when working in the code as well.