Skip to content

Update docs with corrected dashboard URLs - #1158

Merged
dshokouhi merged 4 commits into
home-assistant:masterfrom
travissanderson:patch-1
Jan 10, 2025
Merged

Update docs with corrected dashboard URLs#1158
dshokouhi merged 4 commits into
home-assistant:masterfrom
travissanderson:patch-1

Conversation

@travissanderson

Copy link
Copy Markdown
Contributor

Trying to follow the documentation here didn't end up navigating the app to the correct URL. I tried removing lovelace and it worked, so I updated the wording here accordingly. I also added an example of a subview since that may not be obvious to all readers.

@dshokouhi

Copy link
Copy Markdown
Member

/lovelace/ is still a valid path for some like myself :)

image

This PR tries to solve a similar problem like #1154

Maybe a better fix for this is to create a FAQ item for how to discover a users relative URL and link that to all the pages where relative URLs are used because more than 1 feature relies on it.

@travissanderson

Copy link
Copy Markdown
Contributor Author

Interesting, do you know why that is? I would guess new(er) users will not have lovelace and it is a legacy thing, so having this in the documentation would be better than the current. I suppose the more correct documentation may be to concatenate homeassisant://navigate and the path of the URL you see in the browser when looking at your dashboard in the web app?

@dshokouhi

Copy link
Copy Markdown
Member

Interesting, do you know why that is? I would guess new(er) users will not have lovelace and it is a legacy thing, so having this in the documentation would be better than the current. I suppose the more correct documentation may be to concatenate homeassisant://navigate and the path of the URL you see in the browser when looking at your dashboard in the web app?

yea have had HA for many years and i manage my main dashboard in YAML so definitely legacy on my end :)

i think the best course of action would be to not mention any specific format (as those may change later with new dashboards) and just guide the user to finding their relative path

@travissanderson

Copy link
Copy Markdown
Contributor Author

@dshokouhi let me know what you think of acccf04

@dshokouhi

Copy link
Copy Markdown
Member

Looks good but one exception the android app does not yet support step 4 :)

@travissanderson

Copy link
Copy Markdown
Contributor Author

@dshokouhi do you know if there's a github issue or PR for adding that I could link to? or maybe I can just comment on the planned work to update these docs

@dshokouhi

Copy link
Copy Markdown
Member

@dshokouhi do you know if there's a github issue or PR for adding that I could link to? or maybe I can just comment on the planned work to update these docs

No PR or issue created for it, we can keep this as is and update the docs as needed later. We dont generally mention if things are requested or in progress. Not all features are supported by the other platform so just important to call out what platforms support the features.

@travissanderson

Copy link
Copy Markdown
Contributor Author

Okay, after looking at the netlify preview I realized we're now repeating the same information about 3 times regarding servers. I eliminated the step 4 I had added in favor of the subsection. Does the iOS icon indicate that all these deeplinks are only supported on iOS and Android can only do navigate?

@dshokouhi

Copy link
Copy Markdown
Member

Does the iOS icon indicate that all these deeplinks are only supported on iOS and Android can only do navigate?

yup correct, that's why the icon exists

@travissanderson

Copy link
Copy Markdown
Contributor Author

I think this page may need updated too then as it shows no URL Handler support for either Android minimal or full https://companion.home-assistant.io/docs/core/#feature-comparison

@dshokouhi dshokouhi left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the improvement!

@dshokouhi
dshokouhi merged commit 807ecaf into home-assistant:master Jan 10, 2025
@dshokouhi

dshokouhi commented Jan 10, 2025

Copy link
Copy Markdown
Member

I think this page may need updated too then as it shows no URL Handler support for either Android minimal or full https://companion.home-assistant.io/docs/core/#feature-comparison

ah good call out, yes that should be updated :)

probably need to evaluate the rest too

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

Successfully merging this pull request may close these issues.

2 participants