[docs] Add MDX style checklist to AGENTS.md#6696
Conversation
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughAGENTS.md receives a new "Verifying Style Before Submitting" section that provides a pre-submission checklist for AI agents to verify style compliance with repository standards, including title case, backtick usage for code elements, and preferring Markdown over HTML. ChangesDocumentation and Style Guidance
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
|
closing as not needed since CONTRIBUTING.md is already being pointed to in AGENTS.md |
Description
Proposal — adding a short "Verifying Style Before Submitting" section to
AGENTS.md. Companion to #6695 (CONTRIBUTING.md MDX-style additions).Depends on #6695. This PR links to the
CONTRIBUTING.md#before-submittingchecklist with items added in that PR; merging this before #6695 means the linked items don't exist yet.In #6692 review @jesserockz pointed out style and pattern issues despite both
CONTRIBUTING.mdandAGENTS.mdbeing available to read. The CONTRIBUTING.md additions in #6695 cover the underlying conventions; this PR adds a brief reminder inAGENTS.mdthat points back to the checklist and calls out the items easiest for an agent to overlook.Changes:
@CONTRIBUTING.mdpointerThis is a proposal, not a finished change. Happy to fold this into #6695 if maintainers prefer it bundled, or cut it entirely.
Related issue (if applicable): n/a
Pull request in esphome with YAML changes (if applicable): n/a
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.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:
Comment on this pull request with the following command, replacing
component_namewith your component name in lower_case format with underscores (e.g.,bme280,sht3x,dallas_temp):The ESPHome bot will respond with a downloadable ZIP file containing the SVG image.
Extract the SVG file and place it in the
/public/images/folder of this repository.Use the image in your component's index table entry in
/src/content/docs/components/index.mdx.Example: For a component called "DHT22 Temperature Sensor", use:
Note: All images used in ImgTable components must be placed in
/public/images/as the component resolves them to absolute paths.