Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce new groups in the technical documentation. #984

Merged
merged 6 commits into from
Nov 16, 2022

Conversation

Supereg
Copy link
Member

@Supereg Supereg commented Nov 16, 2022

♻️ 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:

  • Accessory
  • Service
  • Characteristic
  • Controller API
  • Adaptive Lighting
  • Apple TV Remote
  • Camera
  • Doorbell
  • Television
  • HomeKit Accessory Server
  • HomeKit Data Streams (HDS)
  • Model
  • Cryptography
  • TLV8
  • Utils

⚙️ Release Notes

  • Added groups to the technical documentation for better visibility and usability

➕ 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

--

@github-actions github-actions bot added the chore label Nov 16, 2022
* Fix definition import that got lost due to regeneration of definitions
@coveralls
Copy link

Pull Request Test Coverage Report for Build 3478172771

  • 24 of 25 (96.0%) changed or added relevant lines in 11 files are covered.
  • 3 unchanged lines in 3 files lost coverage.
  • Overall coverage decreased (-0.02%) to 65.046%

Changes Missing Coverage Covered Lines Changed/Added Lines %
src/lib/controller/RemoteController.ts 0 1 0.0%
Files with Coverage Reduction New Missed Lines %
src/lib/controller/AdaptiveLightingController.ts 1 20.7%
src/lib/controller/RemoteController.ts 1 24.07%
src/lib/Service.ts 1 71.27%
Totals Coverage Status
Change from base Build 3476369089: -0.02%
Covered Lines: 7396
Relevant Lines: 10589

💛 - Coveralls

@Supereg Supereg merged commit e82a2d4 into beta-0.11.0 Nov 16, 2022
@Supereg Supereg deleted the chore/regenerate-docs branch November 16, 2022 09:54
Supereg added a commit that referenced this pull request Nov 18, 2022
* Move TLVError and HAPHTTPError to the test-utils directory

* Add link to the guide for presenting erroneous accessory state to the user

* Upgrade supported typescript version

* Organize main documentation page by groups

* Regenerate docs

* Setup lint docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants