Skip to content

Clarify nest device trigger documentation#16043

Merged
frenck merged 7 commits into
home-assistant:currentfrom
allenporter:nest_automations_2020_12
Jan 12, 2021
Merged

Clarify nest device trigger documentation#16043
frenck merged 7 commits into
home-assistant:currentfrom
allenporter:nest_automations_2020_12

Conversation

@allenporter
Copy link
Copy Markdown
Contributor

Proposed change

Clarify documentation around device automations, based on threads in community forums.

I see regular confusion on topics such as:

  • Are automations supported?
    • ✔️ Added pointer at the top
  • Where are they?
    • ✔️ Added screenshots
  • Confusion about events vs device triggers
    • ✔️ Put more emphasis on the device triggers, though still kept details on internal events and the SDM API

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:

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.

@probot-home-assistant probot-home-assistant Bot added the current This PR goes into the current branch label Dec 29, 2020
@allenporter allenporter changed the title Nest automations 2020 12 Clarify nest device trigger documentation Dec 29, 2020
Copy link
Copy Markdown
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Small review comments

Comment thread source/_integrations/nest.markdown Outdated
Comment on lines +22 to +27
There is currently support for the following features within Home Assistant:

- [Camera](#camera)
- [Climate](#climate)
- [Sensor](#sensor)
- [Device Triggers](#automation-and-device-triggers)
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.

This list should contain device types supported. A TOC is provided on the right of each page, we don't need to create one.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

One thing I'm confused about is that the text says "device types" but then it lists some entities, which seemed inconsistent. I was playing around with combining this with the list of supported devices in the overview, but it got a bit messy. I'll just revert this all for now.

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.

Well, since we now have a TOC, we actually should start removing these all IMHO.
Instead, I can extract this data from the core source and add it to the frontmatter and show it automatically.

Future improvements 😉

Comment thread source/_integrations/nest.markdown Outdated
Comment thread source/_integrations/nest.markdown Outdated
Comment thread source/_integrations/nest.markdown Outdated
@allenporter allenporter requested a review from frenck December 29, 2020 21:20
@allenporter
Copy link
Copy Markdown
Contributor Author

This is ready for another look, post holiday bump.

@frenck frenck merged commit ffc5ec2 into home-assistant:current Jan 12, 2021
Copy link
Copy Markdown
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Thanks, @allenporter 👍

@github-actions github-actions Bot locked and limited conversation to collaborators Jan 13, 2021
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

None yet

Development

Successfully merging this pull request may close these issues.

2 participants