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

Image path CANBUS update to absolute paths

Open meijer3 opened this issue 1 year ago • 2 comments

https://esphome.io/components/canbus/mcp2515

URL directs towards: https://esphome.io/components/_images/canbus_mcp2515_resistor.png

But the image is located outside the 'compontens' 'folder' https://esphome.io/_images/canbus_mcp2515_resistor.png

Description:

Related issue (if applicable): fixes

Pull request in esphome with YAML changes (if applicable): esphome/esphome#<esphome PR number goes here>

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.

meijer3 avatar Oct 16 '24 06:10 meijer3

Deploy Preview for esphome ready!

Name Link
Latest commit 5b4bfe5173d73f211bff09d2302fccaab0c24d8e
Latest deploy log https://app.netlify.com/sites/esphome/deploys/670f68db69481e0008174dac
Deploy Preview https://deploy-preview-4346--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.

netlify[bot] avatar Oct 16 '24 06:10 netlify[bot]

Walkthrough

The documentation for the MCP2515 and ESP32 CAN bus platforms has been updated to change image references from relative paths to absolute paths. This affects the wiring diagrams for both platforms, ensuring that images are correctly referenced within the documentation structure. The content structure, configuration variables, and overall instructions remain unchanged. No alterations were made to exported or public entities.

Changes

File Change Summary
components/canbus/mcp2515.rst Updated image paths from relative to absolute for resistor and level shifter wiring. Content structure remains unchanged.
components/canbus/esp32_can.rst Updated image paths from relative to absolute for CAN bus wiring options. Content structure remains unchanged.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant MCP2515
    participant ESPHome

    User->>MCP2515: Setup instructions
    MCP2515->>ESPHome: Configuration variables
    ESPHome->>MCP2515: Wiring options (resistor, level shifter)
    MCP2515-->>User: Complete setup

Possibly related PRs

  • #4038: This PR involves changes to the components/canbus/esp32_can.rst and components/canbus/mcp2515.rst files, which are directly related to the documentation updates made in the main PR regarding wiring options and image references.

Suggested reviewers

  • jesserockz

📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 889f5c282fd61b68d4cbb54f8a19b56ec9718d74 and 5b4bfe5173d73f211bff09d2302fccaab0c24d8e.

📒 Files selected for processing (1)
  • components/canbus/esp32_can.rst (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • components/canbus/esp32_can.rst

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 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 Oct 16 '24 06:10 coderabbitai[bot]