-
Story
-
Resolution: Done
-
Major
-
None
-
None
This story only covers API utility functions. CONSOLE-3083 is a separate story that covers components.
Today we are generating documentation for Console's Dynamic Plugin SDK in
frontend/packages/dynamic-plugin-sdk. We are missing ts-doc for a set of hooks and components.
We are generating the markdown from the dynamic-plugin-sdk using
yarn generate-doc
Here is the list of the API that the dynamic-plugin-sdk is exposing:
https://gist.github.com/spadgett/0ddefd7ab575940334429200f4f7219a
Acceptance Criteria:
- Add missing ts-doc for the utility functions and hooks
- Review existing doc comments for any public utility
Out of Scope:
- This does not include work for integrating the API docs into the OpenShift docs
- This does not cover other public components, only utilities.
- clones
-
CONSOLE-3083 Add missing ts-doc for dynamic plugin SDK components
- Closed
- links to