Mirrors_Framework/esphome
1
0
Fork 0
mirror of https://github.com/esphome/esphome.git synced 2026-06-02 03:02:19 +08:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

[ai] Add docs note about keeping component index pages in sync (#14465)

Browse Source 
Co-authored-by: Brandon Harvey <bharvey88@users.noreply.github.com>
Co-authored-by: J. Nick Koston <nick@koston.org>
This commit is contained in:
Brandon Harvey
2026-03-04 19:46:40 -06:00
committed by GitHub
parent c8e7f78a25
commit c0143ac6d6
1 changed files with 1 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.ai/instructions.md
+1
View File
@@ -286,6 +286,7 @@ This document provides essential context for AI models interacting with this pro
* **Documentation Contributions:** * **Documentation Contributions:**
* Documentation is hosted in the separate `esphome/esphome-docs` repository. * Documentation is hosted in the separate `esphome/esphome-docs` repository.
* The contribution workflow is the same as for the codebase. * The contribution workflow is the same as for the codebase.
* When editing a component's documentation page, also update the corresponding component index page to ensure both pages remain in sync.
* **Best Practices:** * **Best Practices:**
* **Component Development:** Keep dependencies minimal, provide clear error messages, and write comprehensive docstrings and tests. * **Component Development:** Keep dependencies minimal, provide clear error messages, and write comprehensive docstrings and tests.