Introduce new groups in the technical documentation. #984
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
♻️ Current situation
As of now, our technical documentation created groups based on the declaration type (e.g. Enumeration, Class, Type Alias).
It was very hard to get an overview over all the types exported by hap-nodejs.
💡 Proposed solution
This PR rethinks this and groups types based on context. The PR introduces the following groups:
⚙️ Release Notes
➕ Additional Information
This PR adds a new GitHub action to verify, that JSDocs are valid and without warnings
Further, this PR fixed several broken documentation links.
Testing
--
Reviewer Nudging
--