Separate release notes #38693
Separate release notes #38693
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe update restructures the "Recent Blog Posts" section in the HTML template to display two separate lists: one for "Release Notes" and another for general blog posts. It introduces individual limits for each list, filters posts based on their categories, and formats the post dates in a consistent "Month day, Year" style. Section headings and icons are updated, and some formatting adjustments are made to anchor tags and indentation for clarity and consistency. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant TemplateEngine
participant SitePosts
User->>TemplateEngine: Render news.html include
TemplateEngine->>SitePosts: Retrieve all posts
TemplateEngine->>TemplateEngine: Filter posts by "Release-Notes" category (limit 2)
TemplateEngine->>TemplateEngine: Filter posts not in "Release-Notes" category (limit 4)
TemplateEngine->>User: Display "Release Notes" list
TemplateEngine->>User: Display "Recent Blog Posts" list
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (3)
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: 2
♻️ Duplicate comments (5)
source/_includes/custom/news.html (5)
33-35: Duplicate: heading semantic issue
The same<h1>concern applies to the "Recent Blog Posts" section. Ensure you maintain a logical heading hierarchy across both cards.
38-38: Duplicate: counter variable clarity
As above, renaming the second loop’scurrenttoblog_countwill improve readability.
45-47: Duplicate:breakcompatibility
You’ve already flaggedbreakfor verification in the first loop.
49-51: Duplicate: date formatting simplification
The same inline formatting recommendation applies here.
52-55: Duplicate: inline style extraction
As above, move the grid and font-size styles into a CSS class.
🧹 Nitpick comments (8)
source/_includes/custom/news.html (8)
4-5: Extract limits to configuration
Hardcodingreleases_post_limit = 2andblog_post_limit = 4in the template reduces flexibility. Consider moving these values to your site’s_config.ymlor front matter so they can be adjusted per environment without touching the include file.
11-11: Rename counter variable for clarity
The genericcurrentvariable is reused for two different loops. Rename it to something likerelease_countto make its purpose clear and avoid confusion when reading the template.
21-23: Simplify date formatting
You can format the date inline without intermediate assignments:<small class="blog-date">{{ post.date | date: "%B %d, %Y" }}</small>This removes the extra
assignstatements and keeps the template concise.
24-27: Extract inline styles into CSS classes
Avoid inlinestyle="display: grid; font-size: 16px". Define a reusable CSS class (e.g.,.post-list-item) in your stylesheet and apply it here to keep markup clean and maintainable.
123-123: Nit: align indentation
Thestyleattribute indentation here is inconsistent with neighboring elements. Please adjust spacing to match project conventions.
143-147: Extract image styling to CSS
Avoid inlinebackground-image,background-size, andpadding-top. Create a CSS class (e.g.,.feature-sotoh2025) and move these properties there—this keeps your templates DRY and maintainable.
161-165: Extract voice promo inline styles
Similarly, move thebackground-image,background-size, andpadding-bottomfor the Assist card into a dedicated CSS class.
180-181: Extract merch store inline styles
The merch store link uses an inlinestylefor the background image. Define a CSS class (e.g.,.merch-store-promo) to hold this styling instead.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_includes/custom/news.html(6 hunks)
🔇 Additional comments (2)
source/_includes/custom/news.html (2)
13-19: Verify Liquidbreaksupport in your environment
The{% break %}tag inside Liquid loops requires Jekyll/Liquid 4.0+. Confirm your build environment supports it. If not, you may need to filter and limit the collection in one go (e.g.,site.posts | where_exp: ... | first: releases_post_limit).
117-118: Formatting only—no action needed
This inline{% for ... %}/{% if ... %}change is purely cosmetic.
Proposed change
This change separates blog posts tagged as release notes into it's own card to help declutter the "recent blog posts" and allow users to see the release notes better.
The release notes card will be limited to 2 posts but the latest blog posts card will remain at 4.
Before:
After:
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit