Goal
The goal of this ticket is to investigate and expand the project's JSDoc coverage to improve in-code documentation and make the codebase easier to understand and maintain.
Bonus
Explore options for extracting and rendering the JSDocs as a static documentation site.
There are tools available that can generate Markdown from JSDoc comments, making it possible to use a GitHub Action to build and deploy the documentation automatically.
List of APIs
TODO: Create a checkbox list of all APIs and check them when JSDocs are added or improved.
Goal
The goal of this ticket is to investigate and expand the project's JSDoc coverage to improve in-code documentation and make the codebase easier to understand and maintain.
Bonus
Explore options for extracting and rendering the JSDocs as a static documentation site.
There are tools available that can generate Markdown from JSDoc comments, making it possible to use a GitHub Action to build and deploy the documentation automatically.
List of APIs
TODO: Create a checkbox list of all APIs and check them when JSDocs are added or improved.