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

Added Troubleshooting section #125

Closed
wants to merge 1 commit into from

Conversation

allanpersson
Copy link

With help/information

With help/information
@balloob
Copy link
Member

balloob commented Dec 9, 2019

We should point people at https://companion.home-assistant.io/ instead.

@allanpersson
Copy link
Author

@ballob good idea, but how do we "seperate" the ios and android app there?
Everything is build up there on the ios app at the moment, so maybe:

Or what do you think?

@dshokouhi
Copy link
Member

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?

@allanpersson
Copy link
Author

allanpersson commented Dec 9, 2019

@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.
@balloob is the boss and should decide how we do it, I'll gladly be responsible for getting instructions for android made, to help the users and prevent issues raised for known problems and/or misuse

@SeanPM5
Copy link

SeanPM5 commented Dec 9, 2019

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)

Another benefit I am noticing just now about this structure, is that it's mostly platform agnostic except for the Integrations section. So theoretically, when the Android app becomes a thing it could possibly share these same docs, and we would simply segment the Integrations section into sub-sections (Integrations/iOS and Integrations/Android).

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:

/integrations/ios/
/integrations/android/

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.

@allanpersson
Copy link
Author

@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.
I feel android is more complicated than ios due to almost every big manufactur make adjustments to the way they handle Android, and therefor trying to help people avoid problems is harder in my opinion 🙏

@balloob
Copy link
Member

balloob commented Dec 9, 2019

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.

@robbiet480
Copy link
Member

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.

@allanpersson
Copy link
Author

Awaiting decision on how to approach this, so for now closing this PR 🙏

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

Successfully merging this pull request may close these issues.

None yet

6 participants