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

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

Open
fredck opened this issue May 5, 2023 · 2 comments
Open

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

fredck opened this issue May 5, 2023 · 2 comments

Comments

@fredck
Copy link

fredck commented May 5, 2023

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
Copy link
Author

fredck commented May 11, 2023

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
Copy link

mikz commented Nov 29, 2023

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.

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

No branches or pull requests

2 participants