Skip to content

Better API documentation #490

Description

@alexbk66

Current Situation

The documentation becomes unreadable and with more devices added it will become impossible to use.

Proposed Change

I think the documentation should be split by device type - for example I'm implementing Lock support - I need all information related to the Lock in one page. I.e. Device List/Status/Command/WebHook.

Also many devices use same (or similar) API, and currently it's very difficult to see the difference, i.e. different Vacuum Cleaner models.

For example I attach the documentation generated by ChatGPT - much more readable.

SwitchBot_API_v1_1_by_family.html

Additional Context

No response

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions