Skip to content

Update GitHub URLs#6093

Open
smarthome-10 wants to merge 4 commits intoesphome:currentfrom
smarthome-10:github
Open

Update GitHub URLs#6093
smarthome-10 wants to merge 4 commits intoesphome:currentfrom
smarthome-10:github

Conversation

@smarthome-10
Copy link
Contributor

Description:

This PR updates some GitHub URLs in the documentation

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

New Component Images

If you are adding a new component to ESPHome, you can automatically generate a standardized black and white component name image for the documentation.

To generate a component image:

  1. Comment on this pull request with the following command, replacing component_name with your component name in lower_case format with underscores (e.g., bme280, sht3x, dallas_temp):

    @esphomebot generate image component_name
    
  2. The ESPHome bot will respond with a downloadable ZIP file containing the SVG image.

  3. Extract the SVG file and place it in the /static/images/ folder of this repository.

  4. Use the image in your component's index table entry in /components/_index.md.

Example: For a component called "DHT22 Temperature Sensor", use:

@esphomebot generate image dht22

@esphome esphome bot added the current label Feb 15, 2026
@netlify
Copy link

netlify bot commented Feb 15, 2026

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit e8c9482
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/699253bb9dec6f0008382cbb
😎 Deploy Preview https://deploy-preview-6093--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.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 15, 2026

Walkthrough

This PR contains minor infrastructure and documentation updates: updating the Pagefind binary download source in the Dockerfile, correcting documentation links and terminology in component guides, updating repository references from master to main branches, and fixing the license URL path in theme configuration.

Changes

Cohort / File(s) Summary
Build Configuration
Dockerfile
Updated curl download URL for pagefind binary from CloudCannon release to Pagefind repository release; extraction and variable substitution remain unchanged.
Documentation Content
content/components/sensor/xiaomi_ble.md, content/guides/diy.md
Corrected capitalization ("bluetooth" → "Bluetooth", "Mija" → "Mijia"), fixed documentation reference paths, updated hyperlinks to component repositories, and changed repository branch references from master to main.
Theme Configuration
themes/esphome-theme/theme.yaml
Updated licenselink URL from direct file path to blob path with current branch reference for proper GitHub display.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

Suggested labels

current

Suggested reviewers

  • swoboda1337
  • clydebarrow
🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Update GitHub URLs' directly and clearly describes the main change in the changeset, which involves updating GitHub URLs across multiple documentation files.
Description check ✅ Passed The description explains that the PR updates GitHub URLs in the documentation and correctly indicates merging into 'current' for documentation fixes, which aligns with the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Merge Conflict Detection ✅ Passed ✅ No merge conflicts detected when merging into current

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
content/components/sensor/xiaomi_ble.md (1)

13-13: Legacy {{< docref >}} shortcode on changed line.

Per coding guidelines, {{< docref >}} is legacy and should be replaced with a standard Markdown link. Since this line was modified in this PR, it's a good opportunity to update it. That said, the entire file uses this shortcode extensively, so a bulk migration might be better suited for a separate PR.

Example replacement for this line
- You may alternatively use ESPHome's {{< docref "/components/bluetooth_proxy" >}} component to forward sensor data to Home Assistant and have Mijia devices configured using its own Mijia BLE component.
+ You may alternatively use ESPHome's [Bluetooth Proxy](/components/bluetooth_proxy) component to forward sensor data to Home Assistant and have Mijia devices configured using its own Mijia BLE component.

As per coding guidelines: **/*.md: Hugo shortcode {{< docref >}} is legacy and should be replaced with standard Markdown links.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments