Skip to content

REST integration documentation lacks troubleshooting information #38178

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

Open
askpatrickw opened this issue Mar 24, 2025 · 3 comments
Open

REST integration documentation lacks troubleshooting information #38178

askpatrickw opened this issue Mar 24, 2025 · 3 comments

Comments

@askpatrickw
Copy link
Contributor

Feedback

The REST Integration lacks troubleshooting information including where to see debug logs.

URL

https://www.home-assistant.io/integrations/rest/

Version

2025.3.4

Additional information

No response

@askpatrickw askpatrickw changed the title REST integration ocumentation lacks troubleshooting information REST integration documentation lacks troubleshooting information Mar 27, 2025
@askpatrickw
Copy link
Contributor Author

It woudl be helpful if integrations (all of them) had links to where see the logs.

https://www.home-assistant.io/integrations/logger/#viewing-logs

@hexEF
Copy link
Contributor

hexEF commented Mar 30, 2025

Fair point! I assume you managed to figure out and resolve the problem via the aforementioned debug logs?

Would you care to share the underlying issue you ran into? This information helps to evaluate whether solely updating the documentation is sufficient, or that the integration could benefit from actual code changes.

Thanks in advance!

@askpatrickw
Copy link
Contributor Author

I was using the REST integration docs to integrate my Peplink into HA, and it didnt' work and I had to use ChatGPT to figure out how to troubleshoot the problem. If there was a troubleshtooting section with details on how to get to the logs... would have saved time.

A troubleshooting section might be good on all integrations.

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

No branches or pull requests

2 participants