esphome-docs icon indicating copy to clipboard operation
esphome-docs copied to clipboard

Redo the homeassistant service call API setup instructions

Open javawizard opened this issue 1 year ago • 5 comments

Add notes to the individual action sections with a link to the setup instructions - that way folks (like my past self) don't miss them when they link directly to an action and then spend an inordinate amount of time trying to figure out why their service call isn't working.

I'm not 100% sure if user-defined services also require this, or if homeassistant.tag_scanned requires it, but this is at least an improvement on the status quo.

Checklist:

  • [ ] I am merging into next because this is new documentation that has a matching pull-request in esphome as linked above.
    or

  • [x] I am merging into current because this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.

  • [ ] Link added in /index.rst when creating new documents for new components or cookbook.

javawizard avatar Feb 23 '24 02:02 javawizard

Deploy Preview for esphome ready!

Name Link
Latest commit dc1403d855d2d8a55b9e626a1368258f360fa80a
Latest deploy log https://app.netlify.com/sites/esphome/deploys/662b82bcaaec5b0008972a75
Deploy Preview https://deploy-preview-3631--esphome.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] avatar Feb 23 '24 02:02 netlify[bot]

This has to be cofigured for any kind of service call to work.

nagyrobi avatar Feb 23 '24 05:02 nagyrobi

This has to be cofigured for any kind of service call to work.

Perfect, this should be good to go as is then. Thank you!

javawizard avatar Feb 24 '24 10:02 javawizard

I think it's a bit overwhelming to repeat the same note 3 times within that small amount of text. It's just a single page.

IMHO the explanation under the Actions title should be enough.

The main thing I'm trying to address is when someone comes in via say a Google search for "esphome call home assistant service" (for which this page is the first result), sees the homeassistant.service action in the table of contents, clicks it, and finds everything they need in that section - except for the fact that they need to do that extra step of enabling service calls for that node in HA.

I spent the better part of an hour trying to figure out what I was doing wrong and totally didn't think to look further up the page, and it appears I'm not the only one to have done that.

So I'll respectfully disagree: I think that as long as there's a ToC link directly to the action, folks will click it and miss the setup note earlier in the page, so I think there's value in having the warning above each individual action.

javawizard avatar Feb 24 '24 13:02 javawizard

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks :+1:

Learn more about our pull request process.

esphome[bot] avatar Feb 25 '24 18:02 esphome[bot]

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions.

github-actions[bot] avatar Apr 26 '24 01:04 github-actions[bot]

Oh hey. Keep this one open please 🤖🤖🤖

javawizard avatar Apr 26 '24 01:04 javawizard