[PG-142] JSDoc Documentation

[pgerke]

The better part of the API is decorated with JSDoc comments. This documentation should be made available to consumers.

• Build JSDoc documentation
• Host on GitHub pages
• Use a template that does not have vulnerabilities
• Add documentation for all public entities

[pgerke]

The initial version of the documentation is available at https://pgerke.github.io/freeathome-local-api-client/

[pgerke]

Unfortunately, there seems to be a vulnerability with the better-docs template that I selected... 🙈

[pgerke]

I couldn't find a JSDoc template that supported Typescript as well as the better-docs template. There are PRs aiming to resolve the vulnerability issues (SoftwareBrothers/better-docs#205 and SoftwareBrothers/better-docs#208). Keeping in mind that the vulnerabilities are development vulnerabilities and do not affect production code, I'll stick with better-docs, hoping that a new version will be released soon.