Skip to content

Added the article about esp-button component#646

Merged
f-hollow merged 18 commits intoespressif:mainfrom
pedrominatel:add-esp-button-component-article
Feb 14, 2026
Merged

Added the article about esp-button component#646
f-hollow merged 18 commits intoespressif:mainfrom
pedrominatel:add-esp-button-component-article

Conversation

@pedrominatel
Copy link
Member

@pedrominatel pedrominatel commented Jan 28, 2026

📝 Description

This article introduces the esp-button component with a practical example for a GPIO button.

Notes:

  • The final link to the full source code is missing.
  • The Asciinema cast is not working.

Publish date

Expected publish date: 2026-02-18

Review process

  • Initiate technical review
    • This item is N/A
    • Add subject matter experts (your team members, experts in the field)
  • Once tech review mostly done, initiate editorial review
    • Add technical editors (@f-hollow, @FBEZ, and/or @pedrominatel)

Checks

  • Article folder and file names:
    • Folder path is content/blog/YYYY/MM/my-new-article (articles only)
    • Folder and file names have no underscores, spaces, or uppercase letters (My new_article)
  • New article's YAML frontmatter:
    • Title updated
    • Date matches the format date: 20YY-MM-DD
    • Summary updated
    • Authors added (see Add youself as an author)
    • Tags added
  • Updated article's YAML frontmatter:
    • This item is N/A
    • If article folder is moved or renamed, the field aliases: with a new URL slug is added
    • Date of update is added lastmode: 20YY-MM-DD
  • Article media files:
    • All images are in .WebP format (see Use WebP for raster images)
    • Images are compressed within 100-300 KB, with a hard limit of ≤ 500 kB
    • Where possible, Hugo shortcodes are used instead of raw HTML for content types unsupported by markdown (see Use additional content types)
  • Links in articles
    • Make sure all links are valid
    • No links to Google docs present
    • Use a specific ESP-IDF version in links (avoid stable, hard no for latest)
  • Git history
    • Commits are clean and squashed to the minimum necessary
    • Commit messages follow Conventional Commits format
    • Your feature branch is rebased on main

🔗 Related

🧪 Testing (Hugo)

@pedrominatel pedrominatel requested a review from f-hollow January 28, 2026 19:54
@pedrominatel pedrominatel requested a review from FBEZ January 29, 2026 12:33
Copy link
Collaborator

@FBEZ FBEZ left a comment

Choose a reason for hiding this comment

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

Thank you for your article. Please find below some comments.


> **Note**: This example uses the [**ESP32-C3-DevKit-RUST-2**](https://docs.espressif.com/projects/esp-dev-kits/en/latest/esp32c3/esp32-c3-devkit-rust-2/index.html) development board. GPIO pin 9 is the button pin on this board, but you can adapt the GPIO pin number to match your specific hardware configuration.

### Step 1: Include Required Headers
Copy link
Collaborator

Choose a reason for hiding this comment

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

The following steps start a bit abruptly. Since is a step-by-step guide, I would add a section mentioning the creation of an empty project and move the "installation" section here.

In the end you're not installing the module at system level, you add it to the project itself.

Copy link
Member Author

Choose a reason for hiding this comment

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

In this case, we can assume that the reader knows about project creation and probably he is adding the component to an existing project.
Adding a component is not the very first step in most cases.

- Long press start, hold, and up events
- Press repeat done and press end notifications

## Application Examples
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe this could be a subsection of the introduction, like key features. It seems to interrupt the flow.
What do you think @f-hollow ?

Copy link
Collaborator

Choose a reason for hiding this comment

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

I see that Key features is not a subsection already. I believe it looks natural now:

  • Introduction
  • Key features
  • Application Examples

Copy link
Collaborator

@f-hollow f-hollow left a comment

Choose a reason for hiding this comment

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

@pedrominatel Thank you for writing the article!

I have a few comments about different aspects.

@pedrominatel
Copy link
Member Author

@f-hollow, PTAL.

Copy link
Collaborator

@f-hollow f-hollow left a comment

Choose a reason for hiding this comment

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

@pedrominatel A couple of nitpicks, otherwise LGTM!

@f-hollow f-hollow merged commit 75387b9 into espressif:main Feb 14, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants