Skip to content
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

Updated platformio to pioarduino in esp32.rst #4681

Merged
merged 3 commits into from
Feb 19, 2025

Conversation

optimusprimespace
Copy link
Contributor

@optimusprimespace optimusprimespace commented Feb 17, 2025

Description:

Updated platformio to pioarduino in both cases (links too). When changing out the platformio framework to pioarduino (see changelog: https://esphome.io/changelog/2024.12.0.html) the docs needs to be updated for the users to not get confused over which framework they use.

Related issue (if applicable): fixes

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

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 /index.rst when creating new documents for new components or cookbook.

Copy link
Contributor

coderabbitai bot commented Feb 17, 2025

Walkthrough

The documentation for the ESP32 platform in components/esp32.rst has been updated. The modifications involve renaming PlatformIO package references in the configuration variables section for both the Arduino and ESP-IDF frameworks. The references have been changed from platformio/espressif32 to pioarduino/espressif32, along with the corresponding URL updates. No other changes have been made to the file.

Changes

File Change Summary
components/esp32.rst Updated documentation: renamed references from platformio/espressif32 to pioarduino/espressif32 for both Arduino and ESP-IDF configuration sections.

Suggested reviewers

  • DjordjeMandic

📜 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 7039732 and 1a18dd7.

📒 Files selected for processing (1)
  • components/esp32.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

  • components/esp32.rst
🔇 Additional comments (2)
components/esp32.rst (2)

65-65: Updated Link for Arduino Framework Correctness
The documentation link for the Arduino framework has been updated to reference pioarduino/espressif32 with the URL set to https://github.com/pioarduino/platform-espressif32/releases (without a trailing slash), which aligns perfectly with the PR objectives.


99-99: Updated Link for ESP-IDF Framework Correctness
The documentation link for the ESP-IDF framework now correctly points to pioarduino/espressif32 with the URL https://github.com/pioarduino/platform-espressif32/releases/ (including the trailing slash), ensuring consistency with the intended update.


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?

❤️ 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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. (Beta)
  • @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.

Copy link

netlify bot commented Feb 17, 2025

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit 1a18dd7
🔍 Latest deploy log https://app.netlify.com/sites/esphome/deploys/67b3ab7c30bb95000876706e
😎 Deploy Preview https://deploy-preview-4681--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 site configuration.

@DjordjeMandic DjordjeMandic merged commit a47d219 into esphome:current Feb 19, 2025
4 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Feb 21, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants