At the moment the documentation is correct, but never are there screenshots or anything so you know which entities or FE elements you can expect.
this one for example
would benefit from a screenshot like this.
So the user knows what to expect.
At the moment the documentation is correct, but never are there screenshots or anything so you know which entities or FE elements you can expect.
this one for example
would benefit from a screenshot like this.
So the user knows what to expect.
“never” is a strong word, which in this case is not correct.
example https://www.home-assistant.io/integrations/github/#service
almost never
but something like this screenshot is what I actually hope to see everywhere.
Screenshots are always tricky. They are quickly outdated and updating them is a lot more complicated than adding a bit of text.
That said, “a picture (often) says more than 1000 words” which I agree with. For certain things in the documentation, especially those chapters new users read, should include some screenshots. May I ask @bkbartk whether you believe to lack the experience to upload screenshots to Github? Just asking because such additions would probably be accepted if you created the PR
which entities or FE elements you can expect.
This is something different I have to agree and disagree with! Screenshots are not suited to show which entities are generated by an integration. This heavily depends on your device and integrations often support dozens of different devices. Your climate device for example might have a valve position or support for a boost mode. Your screenshot isn’t helpful there.
I agree that integrations should describe the entities they generate. For an example see: Kostal Plenticore Solar Inverter - Home Assistant
Integrations don’t have any images AFAIK. This is the UI and is documented under UI elements in docs. Could be much more detailed of course (no examples how to change preset or what you can see in history).
Integrations should just list entities it generate like @ThomDietrich described above and maybe mention what kind of cards can be used if it is something more specific like having climate entities.