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

Separate referring actions from configuration actions

Open donburch888 opened this issue 3 months ago • 4 comments

Description:

This is a minor change moving some of the documentation sections which refer to or use a Text to a new main heading, to separate them from the sections which define the configuration of a Text Sensor.

This provides users with the same information, but should make it easier for less experienced users to see which sections go in the Binary Sensor configuration ... and which should be used in other sensors' configurations.

per: https://github.com/orgs/esphome/discussions/3280

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 /components/index.rst when creating new documents for new components or cookbook.

New Component Images

If you are adding a new component to ESPHome, you can automatically generate a standardized black and white component name image for the documentation.

To generate a component image:

  1. Comment on this pull request with the following command, replacing COMPONENT_NAME with your component name in UPPER_CASE format with underscores (e.g., BME280, SHT3X, DALLAS_TEMP):

    @esphomebot generate image COMPONENT_NAME
    
  2. The ESPHome bot will respond with a downloadable ZIP file containing the SVG image.

  3. Extract the SVG file and place it in the images/ folder of this repository.

  4. Use the image in your component's index table entry in /components/index.rst.

Example: For a component called "DHT22 Temperature Sensor", use:

@esphomebot generate image DHT22

donburch888 avatar Aug 27 '25 09:08 donburch888

Deploy Preview for esphome ready!

Name Link
Latest commit 6872b56a98d1aedcc5a73e09c262ae8959fd9828
Latest deploy log https://app.netlify.com/projects/esphome/deploys/68aed21399a33f0008afa8dd
Deploy Preview https://deploy-preview-5300--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 project configuration.

netlify[bot] avatar Aug 27 '25 09:08 netlify[bot]

Walkthrough

Relocates a sentence about accessing the current text state into a new “Referencing Texts” section in content/components/text/_index.md, anchored as text-referencing, placed before the text-set action anchor. The original sentence is removed from Text Automation. Other content remains unchanged.

Changes

Cohort / File(s) Summary of changes
Documentation Update
content/components/text/_index.md
Added “Referencing Texts” section (anchor: text-referencing); moved the sentence on accessing current text state (id(text_id).state) from Text Automation to the new section; no other content changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested labels

current

Suggested reviewers

  • jesserockz
  • balloob
✨ Finishing Touches
🧪 Generate unit tests
  • [ ] Create PR with unit tests
  • [ ] Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Aug 27 '25 09:08 coderabbitai[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 Dec 06 '25 02:12 github-actions[bot]

So much for "Help improve this documentation".

"Corrections" are only welcome if they add extra features and increase the complexity of documentation. ESPHome (like Home Assistant) is still very much "by engineers for other experienced engineers" ... despite the lip service to becoming more user friendly.

donburch888 avatar Dec 06 '25 04:12 donburch888