Move contributing page to developers.esphome.io #4890
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
There was a problem hiding this comment.
As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.
esphome
bot
dismissed stale reviews from github-actions[bot] and github-actions[bot]
Stale
There was a problem hiding this comment.
As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.
WalkthroughThis change removes the internal contributing guide ( Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant DocsSite
participant ExternalDevSite
User->>DocsSite: Accesses contributing/custom component docs or related redirects
DocsSite-->>User: Redirects to ExternalDevSite (developer blog or documentation)
User->>ExternalDevSite: Views external developer resources
Possibly related PRs
Suggested reviewers
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (7)
components/sensor/pzem004t.rst (1)
11-12: Externalize contributing guide reference to Developer site
Replaced the internal:doc:link with an external hyperlink to https://developers.esphome.io.Consider capitalizing "Developer site" to match other references and maintain consistent link text across the docs:
- `developer site <https://developers.esphome.io>`__ + `Developer site <https://developers.esphome.io>`__components/sensor/pzemdc.rst (1)
10-11: Externalize contributing guide reference to Developer site
Updated the note to point to the external ESPHome developer site instead of the removed internal guide.For consistency, you may want to capitalize the link text:
- `developer site <https://developers.esphome.io>`__ + `Developer site <https://developers.esphome.io>`__components/sensor/pzemac.rst (1)
11-12: Externalize contributing guide reference to Developer site
Replaced the internal documentation link with an external URL to the ESPHome developer site.To maintain uniform casing in link texts, consider:
- `developer site <https://developers.esphome.io>`__ + `Developer site <https://developers.esphome.io>`__components/sensor/bl0940.rst (1)
11-12: Externalize contributing guide reference to Developer site
Updated the note to reference the external ESPHome developer site instead of the removed internal guide.Align this link text with others by capitalizing "Developer site":
- `developer site <https://developers.esphome.io>`__ + `Developer site <https://developers.esphome.io>`__changelog/v1.13.0.rst (1)
99-99: Add external reference for updated contributing guidelines.The changelog notes “contribution guidelines have been updated” but doesn’t point readers to the new external guide. Consider adding a direct link to https://developers.esphome.io/contributing/code/ so users can quickly find the updated instructions.
guides/installing_esphome.rst (2)
106-107: Consider linking to a more specific development‐environment guide.The new copy points to the root of the developer site. For better UX, you might link directly to the page on setting up a development environment (if one exists) rather than the homepage.
166-166: Confirm the See Also link targets the intended resource.The “Developer site” entry replaces the old internal reference—ensure it clearly directs users to the contributing/development guide. You may also consider renaming the link text (e.g., “Contributing Guide”) for clarity.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (14)
_redirects(1 hunks)changelog/2025.2.0.rst(1 hunks)changelog/v1.13.0.rst(1 hunks)components/external_components.rst(1 hunks)components/index.rst(1 hunks)components/sensor/ade7953.rst(1 hunks)components/sensor/bl0940.rst(1 hunks)components/sensor/pzem004t.rst(1 hunks)components/sensor/pzemac.rst(1 hunks)components/sensor/pzemdc.rst(1 hunks)guides/contributing.rst(0 hunks)guides/faq.rst(1 hunks)guides/installing_esphome.rst(2 hunks)index.rst(1 hunks)
💤 Files with no reviewable changes (1)
- guides/contributing.rst
🧰 Additional context used
📓 Path-based instructions (1)
`**`: - Do not generate or add any sequence diagrams
**: - Do not generate or add any sequence diagrams
components/sensor/pzemdc.rstcomponents/external_components.rstchangelog/v1.13.0.rstcomponents/sensor/bl0940.rst_redirectsguides/faq.rstcomponents/sensor/pzemac.rstcomponents/sensor/pzem004t.rstindex.rstcomponents/sensor/ade7953.rstchangelog/2025.2.0.rstguides/installing_esphome.rstcomponents/index.rst
🔇 Additional comments (7)
guides/faq.rst (1)
648-648: Update "See Also" to point to Developer site
Removed the internal contributing guide reference and added a direct external link to the ESPHome Developer site.components/sensor/ade7953.rst (1)
10-11: Update contributing link to external developer site.
The internal link to the local contributing guide has been correctly replaced with a hyperlink to https://developers.esphome.io, aligning with the new documentation strategy.index.rst (1)
54-54: Rename and redirect the "Contributing" nav link.
The link label has been updated to “Development” and now points to https://developers.esphome.io, matching other external resource links.components/index.rst (1)
1092-1093: Replace internal contributing section with external link.
The “Contributing” section now directs users to https://developers.esphome.io, consistent with the removal of the internal guide.components/external_components.rst (1)
11-12: Direct custom component instructions to external developer site.
Internal reference to the contributing guide has been accurately replaced with a link to https://developers.esphome.io, ensuring consistency across docs.changelog/2025.2.0.rst (1)
58-59: Update changelog to link to external blog post.
The reference-style link has been converted into an explicit external hyperlink to the developer blog, making the entry more self-contained and clear._redirects (1)
17-31: Redirects updated to external developer site and blog post.The
/guides/contributing*redirect now points to the official contributing page, and all custom component paths correctly redirect to the blog post about removal of support for custom components. This aligns with the deletion of the internal guide and ensures users land on the up-to-date external resources.
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.
Description:
esphome/developers.esphome.io#11 should be merged first as it contains the requisite blog entry about custom components being removed.
Related issue (if applicable): fixes
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
/components/index.rstwhen creating new documents for new components or cookbook.