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

Integration Document Unclear #36706

Open
trekbear opened this issue Jan 4, 2025 · 1 comment
Open

Integration Document Unclear #36706

trekbear opened this issue Jan 4, 2025 · 1 comment
Assignees

Comments

@trekbear
Copy link

trekbear commented Jan 4, 2025

Feedback

Hello. I was reading the I tracker integration document and I was more confused by the end of it. Forgive me, I am dyslexic and I find some documents incredibly difficult to read. It gave what seemed to be large amounts of technical detail but I am none the wiser how to make this work

URL

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

Version

2025.1.0

Additional information

I understand that there is a drive to make documents for integrations better. My understanding is that the document should inform me how to install and make use of an integration - I am sure if you are technical and well versed in this subject it’s really clear - but to me it wasn’t I’m afraid. Maybe for all documentation a “friends and family” test could be considered - eg, would your Mum be able to use this document to set up the integration and make use of it? I comment because I want to make things better so I can look at the document and feel confident that I understand more by the end.

@home-assistant
Copy link

home-assistant bot commented Jan 4, 2025

Hey there @bdraco, mind taking a look at this feedback as it has been labeled with an integration (ibeacon) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of ibeacon can trigger bot actions by commenting:

  • @home-assistant close Closes the feedback.
  • @home-assistant rename Awesome new title Renames the feedback.
  • @home-assistant reopen Reopen the feedback.
  • @home-assistant unassign ibeacon Removes the current integration label and assignees on the feedback, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information) to the feedback.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information) on the feedback.

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