Add Blueprint Editor #39316
Add Blueprint Editor #39316
Conversation
|
It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the |
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughA new tutorial document for the Blueprint Editor was introduced, detailing how to create an automation that plays a song when a person enters a zone. Additionally, the documentation sitemap was updated to include a conditional link to this new tutorial under the Blueprints section. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Docs Site
participant Blueprint Editor
User->>Docs Site: Navigate to Blueprints section
Docs Site->>User: Display list of tutorials (including "Editor" if conditions met)
User->>Docs Site: Open "Blueprint Editor" tutorial
Docs Site->>User: Show step-by-step guide for creating automation
User->>Blueprint Editor: Follow instructions to create automation
Blueprint Editor->>User: Allow input of person, zone, song, speaker, trigger, and action
User->>Blueprint Editor: Save blueprint
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
source/_docs/blueprint/editor.markdown (3)
6-7: Refine phrasing for clarity
Consider updating “come in the house” to “enter the house” or “come home” for smoother, more natural language.
8-9: Verify the custom include and styling
- Ensure the
{% my blueprints %}tag correctly renders “Settings > Automations & scenes > Blueprints”.- Consider hyphenating “lower right corner” to “lower-right corner” for consistency in compound adjectives.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~8-~8: Consider adding a hyphen.
Context: ...cenes** > Blueprints" %} and in the lower right corner, select the Add Blueprint bu...(TOP_LEFT_CORNER)
10-10: Enhance image alt text
The alt text “Create blueprint dialogue box” could be more descriptive (for example, “Screenshot of the ‘Create new automation blueprint’ dialog in the Blueprint Editor”).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
⛔ Files ignored due to path filters (7)
source/images/docs/blueprint-editor/create-blueprint.pngis excluded by!**/*.pngsource/images/docs/blueprint-editor/person-input.pngis excluded by!**/*.pngsource/images/docs/blueprint-editor/place-input.pngis excluded by!**/*.pngsource/images/docs/blueprint-editor/play-action.pngis excluded by!**/*.pngsource/images/docs/blueprint-editor/song-input.pngis excluded by!**/*.pngsource/images/docs/blueprint-editor/speaker-input.pngis excluded by!**/*.pngsource/images/docs/blueprint-editor/zone-trigger.pngis excluded by!**/*.png
📒 Files selected for processing (2)
source/_docs/blueprint/editor.markdown(1 hunks)source/_includes/asides/docs_sitemap.html(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_docs/blueprint/editor.markdown
[uncategorized] ~8-~8: Consider adding a hyphen.
Context: ...cenes** > Blueprints" %} and in the lower right corner, select the Add Blueprint bu...
(TOP_LEFT_CORNER)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (5)
source/_includes/asides/docs_sitemap.html (1)
34-34: Verify the blueprint editor link path and condition
Ensure that/docs/blueprint/editor/matches the actual routing and file structure so the page is properly discoverable. Also confirm thatdoc == 'blueprint'covers subroutes likeblueprint/editorso the link appears when viewing the editor page.source/_docs/blueprint/editor.markdown (4)
1-4: Confirm required front matter fields
The front matter currently includestitleanddescription. Please verify if additional metadata (e.g.,sidebar_label,sidebar_position, orlayout) is required to meet project conventions and ensure proper navigation.
56-61: Validate the trigger YAML snippet
Confirm that the provided YAML matches the Blueprint Editor UI’s expectations (e.g., usingplatform: zonevs.trigger: zone, proper indentation, and required keys).
70-76: Validate the action YAML snippet
Please verify that usingaction: media_player.play_media(instead ofservice:) and the nesting oftarget/dataaligns with the editor’s YAML schema.
82-85: Verify the “Using a Blueprint” link
Check that the anchor/docs/blueprint/tutorial/#using-the-blueprint-via-the-uipoints to a valid header in the target document and loads correctly.
Proposed change
This adds documentation for the new blueprint editor created in PRs ADDME1 and ADDME2
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit