[m4e] Add note to create PR in esphome/esphome-devices #4290
Conversation
WalkthroughThe document Changes
Possibly related PRs
Suggested reviewers
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 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 (
|
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
guides/made_for_esphome.rst (2)
47-53: LGTM! Consider adding a link to the devices website.The added instructions for applying to the "Made for ESPHome" program are clear and align well with the PR objectives. They provide valuable guidance for creators looking to list their devices.
Consider adding a direct link to the devices website (https://devices.esphome.io) in addition to the GitHub repository link. This would allow potential applicants to easily view existing listed devices for reference.
Line range hint
61-95: LGTM! Comprehensive logo options provided.The inclusion of multiple logo variants (black on white, white on black, black on transparent, white on transparent) in both SVG and PNG formats is excellent. This provides creators with flexibility for various use cases and design requirements.
Consider adding a brief note about recommended usage scenarios for each logo variant (e.g., "White on black is ideal for dark backgrounds or packaging"). This could help creators choose the most appropriate logo for their specific needs.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- guides/made_for_esphome.rst (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
guides/made_for_esphome.rst (1)
Pattern
**: - Do not generate or add any sequence diagrams
🔇 Additional comments (2)
guides/made_for_esphome.rst (2)
58-59: LGTM! Clear instructions for logo usage.The added section on logos provides clear guidance for approved projects. This information is valuable for creators and aligns well with the "Made for ESPHome" program objectives.
Line range hint
47-95: Overall, excellent additions to the "Made for ESPHome" documentation!The changes in this PR successfully address the objective of adding a note about creating a pull request in the esphome/esphome-devices repository. Additionally, the PR goes beyond this by providing comprehensive information about the application process and logo usage for approved projects.
These additions will greatly benefit creators looking to participate in the "Made for ESPHome" program by:
- Clarifying the application process
- Providing guidance on creating a pull request for device listing
- Offering clear instructions on logo usage post-approval
The changes are well-structured, clear, and align perfectly with the documentation's purpose.
kbx81
changed the title
Description:
SSIA
Related issue (if applicable): fixes
Pull request in esphome with YAML changes (if applicable): esphome/esphome#
Checklist:
I am merging into
nextbecause this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
currentbecause this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.Link added in
/index.rstwhen creating new documents for new components or cookbook.