-
-
Notifications
You must be signed in to change notification settings - Fork 2k
Update installing_esphome.rst to mention git for extern. components #4987
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: current
Are you sure you want to change the base?
Conversation
include a mention of installing git in notes for using external components
WalkthroughThe ESPHome installation guide was updated with newer ESPHome version examples, raised minimum Python version requirements from 3.9 to 3.10, removed command prompt symbols from example commands, rephrased caution notes, and added a new note advising Windows users to install Git for external components with a download link. 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)
⏰ Context from checks skipped due to timeout of 90000ms (1)
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
guides/installing_esphome.rst (1)
44-51
: Refine Git installation note for clarity.
Consider rephrasing the second bullet to an imperative form (e.g., “Ensure Git is installed to use external components”) to match the documentation tone and remove ambiguity. Also verify thathttps://git-scm.com/downloads/win
correctly points to the Windows installer download.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
guides/installing_esphome.rst
(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**`: - Do not generate or add any sequence diagrams
**
: - Do not generate or add any sequence diagrams
guides/installing_esphome.rst
🔇 Additional comments (1)
guides/installing_esphome.rst (1)
25-27
: Verify Python version recommendation.
The Windows installation example was updated to Python 3.13.2; please confirm this reflects the latest stable Windows release from the official Python downloads page.
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
Description:
include a mention of installing git in notes for using external components
Also minor touchup of the overall guide
Related issue (if applicable): fixes NONE
Pull request in esphome with YAML changes (if applicable): NONE
Checklist:
I am merging into
next
because this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
current
because this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.Link added in
/components/index.rst
when creating new documents for new components or cookbook.