Skip to content

Add endstop valve platform documentation#6722

Open
exciton wants to merge 2 commits into
esphome:nextfrom
exciton:endstop-valve
Open

Add endstop valve platform documentation#6722
exciton wants to merge 2 commits into
esphome:nextfrom
exciton:endstop-valve

Conversation

@exciton
Copy link
Copy Markdown
Contributor

@exciton exciton commented Jun 2, 2026

Description

Adds endstop valve platform docs

Pull request in esphome with YAML changes (if applicable):

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 /src/content/docs/components/index.mdx 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 /public/images/ folder of this repository.

  4. 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:

@esphomebot generate image dht22

Note: All images used in ImgTable components must be placed in /public/images/ as the component resolves them to absolute paths.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Copy link
Copy Markdown

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

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

ImgTable blocks are not in alphabetical order

Found 1 ImgTable block(s) with incorrect ordering below Network Protocols.
Each table has at most one Core item (matching the section name, e.g. "Sensor Core" for the Sensor section), pinned first, followed by Template items (names starting with "Template "), then all remaining items sorted alphabetically.

You can fix this automatically by running:

node script/check_component_index.mjs --fix

See the inline suggestions below for the correct order in each section.

Comment thread src/content/docs/components/index.mdx
@esphome esphome Bot marked this pull request as draft June 2, 2026 04:58
@esphome
Copy link
Copy Markdown

esphome Bot commented Jun 2, 2026

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@netlify
Copy link
Copy Markdown

netlify Bot commented Jun 2, 2026

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit 30dc37b
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/6a1e634b9c4df200084bc9cb
😎 Deploy Preview https://deploy-preview-6722--esphome.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@github-actions github-actions Bot dismissed their stale review June 2, 2026 05:00

Component index ordering has been fixed — dismissing review.

@exciton exciton marked this pull request as ready for review June 2, 2026 05:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant