-
Notifications
You must be signed in to change notification settings - Fork 623
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
Added Troubleshooting section #125
Conversation
With help/information
We should point people at https://companion.home-assistant.io/ instead. |
@ballob good idea, but how do we "seperate" the ios and android app there?
Or what do you think? |
I noticed that some of the instructions on the companion site like around removing config entry and entities are helpful for Android as well. Its probably time we review that site and find a way to split things up? Maybe make the pages more generalized and have ios and android sections at the bottom of each page for OS specific things? |
@dshokouhi I agree, some stuff is relevant for both Android and ios. The current instructions is very specific ios, and I fear if we don't make two seperate instructions people will be confused and alot off issue/support tickets will come, if we just put android instructions in the same place also. |
Tom Brien and I discussed this briefly when we were writing all the docs for the companion site. Here is what I wrote back in May. home-assistant/companion.home-assistant#67 (comment)
I think that by sharing the same docs it'll make them better for everyone as the entire community would be contributing to one document. More eyeballs reading over it, improving it and making it easy to understand. One easy to remember URL to point users to. Avoids issues where only one of the docs gets updated and not the other. This would require some work to generalize the existing pages. And then for the really platform-specific stuff, that would be handled like this:
So there would be an "Integrations" landing page that asks what platform you use, the user clicks the Android logo or the iOS logo and then it takes you to one of the above links. I don't know if this idea is feasible in the end, or what everyone would prefer though. |
@SeanPM5 I think it should be handled with a choice of are you using android og ios, and then to a underpage specific for each integration. |
Thanks for chiming in @SeanPM5. Since both apps are using mobile_app integration, and we're aiming for feature parity for configuration, I think that a lot of trouble shooting can be shared. |
Let's continue the larger conversation about splitting up docs for Android & iOS at home-assistant/companion.home-assistant#137. As for this PR, I think we should just have a link to the companion docs if anything in troubleshooting. |
Awaiting decision on how to approach this, so for now closing this PR 🙏 |
With help/information