[rp2] Rename rp2040 platform page to rp2 and add redirects#6830
Open
jesserockz wants to merge 3 commits into
Open
[rp2] Rename rp2040 platform page to rp2 and add redirects#6830jesserockz wants to merge 3 commits into
jesserockz wants to merge 3 commits into
Conversation
Mirror the esphome rp2040 -> rp2 platform rename: move the platform page to /components/rp2/, add netlify redirects for the old URLs, and repoint internal links to the new page.
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
18 tasks
Contributor
There was a problem hiding this comment.
Pull request overview
Updates ESPHome docs to reflect the platform rename from rp2040 to rp2, including moving/retitling the platform page, updating example YAML keys and internal links, and adding Netlify redirects for legacy URLs.
Changes:
- Updated the RP2 platform documentation page content and YAML examples to use the
rp2:key and explain therp2040:alias deprecation timeline. - Repointed internal documentation links (component index + related component pages) to
/components/rp2/. - Added Netlify redirects for legacy
/components/rp2040/and/components/rp2040.htmlURLs.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/content/docs/components/rp2040_ble.mdx | Updates “See Also” link to point to the renamed RP2 platform page. |
| src/content/docs/components/rp2.mdx | Revises page title/description, adds rename/deprecation note, updates YAML examples and reference links to rp2. |
| src/content/docs/components/index.mdx | Updates the supported microcontrollers table entry to “RP2” and links to /components/rp2/. |
| src/content/docs/changelog/2024.6.0.mdx | Updates a changelog link destination from the old RP2040 page to the new RP2 page. |
| netlify.toml | Adds redirects from old RP2040 documentation URLs to the RP2 page. |
Add a /components/rp2040 (no trailing slash) redirect and change the 2024.6.0 changelog link text to rp2 so it matches the rp2 destination.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Documents the platform rename from
rp2040torp2in esphome/esphome#17145. Moves the platform page to/components/rp2/, adds redirects from the old/components/rp2040/and legacy.htmlURLs, updates the canonical YAML examples to therp2:key, and repoints internal links to the new page. A note documents that the legacyrp2040:key keeps working as a deprecated alias until 2027.7.0.Related issue (if applicable): N/A
Pull request in esphome with YAML changes (if applicable):
Checklist
I am merging into
nextbecause this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
currentbecause this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.Link added in
/src/content/docs/components/index.mdxwhen creating new documents for new components or cookbook.