esphome-docs icon indicating copy to clipboard operation
esphome-docs copied to clipboard

Update installing_esphome.rst to mention git for extern. components

Open shvmm opened this issue 6 months ago • 3 comments

Description:

include a mention of installing git in notes for using external components Also minor touchup of the overall guide

  • Mentioned Python version bumped from 3.9 to 3.10
  • ESPHome version mentioned bumped to 2025.5.2

Related issue (if applicable): fixes NONE

Pull request in esphome with YAML changes (if applicable): NONE

  • esphome/esphome#<esphome PR number goes here> NONE

Checklist:

  • [ ] I am merging into next because this is new documentation that has a matching pull-request in esphome as linked above.
    or

  • [x] 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.

shvmm avatar Jun 09 '25 18:06 shvmm

Walkthrough

The 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

File(s) Change Summary
guides/installing_esphome.rst Updated ESPHome and Python version examples; removed command prompt symbols from commands; rephrased caution notes; added Git install note with link for Windows users; reformatted troubleshooting notes.

Possibly related PRs

  • esphome/esphome-docs#4516: Updates macOS installation instructions in the same documentation file, clarifying commands and updating version numbers.

Suggested reviewers

  • clydebarrow

📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 58b1b77e7c8ace260136707b0347cd09bbd84498 and ba997fc9972fd0ecae9c525453f538d65af32d7c.

📒 Files selected for processing (1)
  • guides/installing_esphome.rst (5 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • guides/installing_esphome.rst
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Jun 09 '25 18:06 coderabbitai[bot]

Deploy Preview for esphome ready!

Name Link
Latest commit ba997fc9972fd0ecae9c525453f538d65af32d7c
Latest deploy log https://app.netlify.com/projects/esphome/deploys/684fd1726869830008dc992c
Deploy Preview https://deploy-preview-4987--esphome.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

netlify[bot] avatar Jun 09 '25 18:06 netlify[bot]

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks :+1:

Learn more about our pull request process.

esphome[bot] avatar Jun 09 '25 19:06 esphome[bot]