Improve Feedreader docs #38608
Improve Feedreader docs #38608
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughA new glossary term, "Event entity," was added to the glossary data, providing a definition and a documentation link. The Feedreader integration documentation was expanded and reorganized for improved clarity, with explicit configuration options, enhanced event data explanations, and new sections for automation, event listeners, example configurations, and integration removal. The documentation now distinguishes between "Event" and "Event entity" and includes updated references and formatting improvements. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Feedreader Integration
participant Automation Engine
participant Custom Integration
User->>Feedreader Integration: Configure feed URL and options
Feedreader Integration-->>Feedreader Integration: Polls feed at intervals
Feedreader Integration->>Feedreader Integration: Detects new feed entry
Feedreader Integration->>Automation Engine: Emits event entity with entry data
Automation Engine->>User: Triggers automation based on event entity
Custom Integration->>Feedreader Integration: Listens for feedreader events
Feedreader Integration->>Custom Integration: Provides event data (link, title, description, content)
Tip ⚡💬 Agentic Chat (Pro Plan, General Availability)
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:
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: 3
🧹 Nitpick comments (5)
source/_data/glossary.yml (1)
264-270: Add "Event entity" glossary term—consider providing an excerpt for tooltips
You've correctly inserted an alphabetical entry forEvent entity. To enhance usability in tooltips, it would be helpful to add anexcerpt:field (short summary) as with other terms.Example:
- term: Event entity definition: >- Events are signals that are emitted when something happens, for example, when a user presses a physical button like a doorbell or when a button on a remote control is pressed. link: /integrations/event + excerpt: > + Signals emitted when something happens, such as a button press.source/_integrations/feedreader.markdown (4)
39-41: Improve grammar in Automation subsection
The phrase “to {% term trigger %} automation actions” is slightly awkward. Consider rewording to “to trigger automation actions” for clarity.Example:
- Feedreader events can be used out of the box to {% term trigger %} automation actions, e.g.: + Feedreader events can be used out of the box to trigger automation actions, e.g.:
75-82: Split long sentence and ensure proper Markdown table spacing
The sentence before the table is long and comma‑heavy. It’s clearer as two sentences. Also, ensure there’s a blank line before and after the table for correct Markdown rendering.Example:
-The `trigger.event.data` variable contains at least the following keys, there might be more depending on the data the configured feed is providing. +The `trigger.event.data` variable contains at least the following keys. Additional keys may be present depending on the feed’s data. | Key | Description | | --- | ----------- | | `trigger.event.data.link` | The URL to this feed entry. | ...
84-87: Standardizetermmacro usage for “Event entity”
You’ve used{% term "Event entity" %}here but elsewhere call{% term Event %}without quotes. It’s best to stick to one style. If the macro supports unquoted multi‑word terms, drop the quotes:Example:
- An {% term "Event entity" %} entity will be created ... + An {% term Event entity %} entity will be created ...
105-107: Refine “Other examples” phrasing
The wording “For a drop in packaged complete example” is a bit clunky. Consider “For a complete drop‑in example” or “As a packaged drop‑in example.”Example:
- For a drop in packaged complete example of Feedreader, you can use the... + For a complete drop‑in example of Feedreader, you can use the...
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
source/_data/glossary.yml(1 hunks)source/_integrations/feedreader.markdown(4 hunks)
🔇 Additional comments (3)
source/_integrations/feedreader.markdown (3)
15-16: Verify related documentation link is correct
Please ensure that/common-tasks/general/#defining-a-custom-polling-intervalexists and points to the intended section. Broken links in frontmatter can cause the site build to fail.
30-30: Includeoption_flowmacro only if options are supported
You’ve inserted{% include integrations/option_flow.md %}. Confirm that Feedreader actually supports an options flow in the UI; otherwise, remove this include to prevent a broken include.
94-96: Approve Event listener section
The new “Event listener” subsection clearly shows how to hook into thefeedreaderevent viahass.bus.listen. Well done.
Proposed change
This improves the Feedreader docs, as it
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit