home-assistant/developers.home-assistant

API documentation link at the the home page is misleading/wrong

fredck opened this issue · 2 comments

fredck commented

I'm constantly trying to find the API documentation and it is a pretty hard task. I (and Google) always get tricked buy the "Home Assistant API" link which is at the home page (as expected, which instead links to the WebSocket API documentation.

I was tempted to edit the index file directly here on GitHub to propose "fixing" it but I thought that maybe that's on purpose. In such a case, I would propose to:

  1. Rename the current link text to "Home Assistant WebSocket API"
  2. Add "Home Assistant API", linking to https://dev-docs.home-assistant.io/

The second point is optional, if you guys think that the home page is not the right place for that (but then where?). But at least point 1 would make the link less confusing.

Thanks!

fredck commented

The API should be linked to https://dev-docs.home-assistant.io/en/dev/index.html actually, since the root redirects to the "master" docs which is mostly empty.

mikz commented

All the links you posted now point at https://developers.home-assistant.io so it is impossible to get the actual API documentation.

This is pretty big issue. I did not figure out a way to get the generated API documentation reference.