docs: rewrite all config UI descriptions for clarity and consistency#1446
Open
florianhorner wants to merge 4 commits intobasnijholt:mainfrom
Open
docs: rewrite all config UI descriptions for clarity and consistency#1446florianhorner wants to merge 4 commits intobasnijholt:mainfrom
florianhorner wants to merge 4 commits intobasnijholt:mainfrom
Conversation
Author
What this PR doesThis PR rewrites all 39 config option descriptions from jargon-heavy, emoji-laden text into clean, concise plain English. It adopts the standard Home Assistant pattern: short label + detailed tooltip (via Before / After Examples
Key improvements
Companion PRPR #1450 builds on this work by splitting the 40-option wall into a 5-step guided wizard (Essentials → Sleep → Sun & Timing → Behavior → Workarounds) with room presets. Together these two PRs address the #2 most-cited user frustration (config tedium). |
5 tasks
1e9d751 to
45c897e
Compare
Replace all DOCS strings in const.py with clear, user-friendly descriptions written with a technical writer mindset. Fix the update-strings.py heuristic so every option gets a clean label with a tooltip instead of cramming descriptions into labels. - Rewrite 38+ option descriptions: plain language, no jargon - Strip decorative emoji (keep only⚠️ for genuine warnings) - Fix update-strings.py: remove 40-char heuristic, all options now use the tooltip pattern (data_description) consistently - Update DOCS_MANUAL_CONTROL and DOCS_APPLY for services - Regenerate strings.json, en.json, and services.yaml Addresses feedback from basnijholt#1252, basnijholt#1431, basnijholt#1062 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
d418ec4 to
e59bb69
Compare
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
4 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Rewrites all 39 config option descriptions from jargon-heavy, emoji-laden text into clean, concise plain English. Adopts the standard Home Assistant pattern: short label + detailed tooltip (via
data_description).Before / After Examples
lightslights: List of light entity_ids to be controlled (may be empty). 🌟lights· Tooltip: "Light entities controlled by this switch. Leave empty to add lights later."take_over_controltake_over_control: Pause adaptation of individual lights and hand over (manual) control... 🔒take_over_control· Tooltip: "Pauses adaptation when another source changes a light..."skip_redundant_commandsskip_redundant_commands: Skip sending adaptation commands... 📉Disable if physical light states get out of sync...skip_redundant_commands· Tooltip: "Skips commands when the target state matches the light's last known state, reducing network traffic. Disable if light states drift out of sync."Key improvements
Companion PR
PR #1450 builds on this work by splitting the 40-option wall into a 5-step guided wizard with room presets.
🤖 Generated with Claude Code