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

Documentation page: add links to Yellow and SkyConnect docs #27070

Merged
merged 2 commits into from
Apr 20, 2023

Conversation

c0ffeeca7
Copy link
Contributor

  • attempt to make it easier to find Yellow and SkyConnect documentation
  • add links to Documentation menu in navigation bar
  • add links in aside

Proposed change

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

  • Link to parent pull request in the codebase:
  • Link to parent pull request in the Brands repository:
  • This PR fixes or closes issue: fixes #

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

- add links to Documentation menu in navigation bar
- add links in aside
@home-assistant home-assistant bot added the current This PR goes into the current branch label Apr 20, 2023
@c0ffeeca7 c0ffeeca7 marked this pull request as ready for review April 20, 2023 08:00
@agners
Copy link
Member

agners commented Apr 20, 2023

Background: This came from Support side: People seem to have a hard time to find documentation when they are on the product pages (/skyconnect or /yellow).

However, I don't think they should be that prominent in the documentation section. Maybe we can make it otherwise clear that they are still on the home-assistant.io website, and documentation for these things is to be found elsewhere.

Comment on lines 47 to 51
<li>
<a href="https://yellow.home-assistant.io/">Home Assistant Yellow</a>
</li>
<li>
<a href="https://skyconnect.home-assistant.io/">Home Assistant SkyConnect</a>
Copy link
Member

Choose a reason for hiding this comment

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

I do get the idea, and understand the issue. I do think this might not be the best place. Mostly, because this is now a main menu item navigating away from the website, which is (IMHO) very confusing.

- implement review feedback by @frenck, @agners
@c0ffeeca7
Copy link
Contributor Author

Good point. I see the concern. Can we agree to keep the links in the aside?

@frenck frenck merged commit a274a63 into current Apr 20, 2023
@frenck frenck deleted the yellow-skyconnect-add-links-to-docs branch April 20, 2023 18:01
@github-actions github-actions bot locked and limited conversation to collaborators Apr 21, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
current This PR goes into the current branch
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants