Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Baffling headline: "ESP32-C3-LCDKit is...designed for wildlife protection." <-- ??? (AEGHB-630) #93

Open
3 tasks done
nativeit opened this issue Apr 19, 2024 · 1 comment

Comments

@nativeit
Copy link

Answers checklist.

  • I have read the documentation ESP-IDF Programming Guide and the issue is not addressed there.
  • I have updated my IDF branch (master or release) to the latest version and checked that the issue is present there.
  • I have searched the issue tracker for a similar issue and not found a similar issue.

General issue report

Context

While consulting the online docs for this board, I was surprised to see that the very first sentence describing the ESP32-C3-LCDKit reads (emphasis added):

ESP32-C3-LCDkit is a development board designed for wildlife protection. It is used to evaluate and verify the application of the ESP32-C3 screen. And it is composed of mainboard and subboard.

Links

Questions & Concerns

Was that portion written by an LLM bot? Was this possibly mistranslated? It is a rather nonsensical statement, how is this board designed for "wildlife protection"?

It wouldn't be a big deal, but that sentence is the very first in the documentation for this kit--one of the nicer and more expensive dev kits for this platform--and it has been copied/repeated in a number of retail listings as a result.

I would hate to think someone might be discouraged from purchasing one because they read this and assumed it wouldn't be relevant to the sorts of applications for which it's well-suited--things like home automation, device control, peripheral interfaces, sensor readout/control, etc..

There is also a less problematic, but easily remedied issue with the way the rest of the paragraph is phrased. It is not normally considered "proper" to begin a sentence with "And", but more than that it's just sort of clunky, and could be better constructed as the headline for this kit's otherwise generous documentation.

Proposed Solution

My suggestion would be to replace the confusing text with something more like what was included with the documentation for the LCD breakout board (link):

ESP32-C3-LCD-Ev-Board is an ESP32-C3-based evaluation development board with an SPI interface display. It also has an integrated rotary encoder switch and features screen interaction. Due to its low cost, low power consumption, and high performance, ESP32-C3 satisfies the basic GUI interaction needs, gaining ground in scenarios with small screen sizes.

I would be glad to fix the language and submit a pull request, if that would be welcome?

Thanks

Thanks for hearing out my pedantic issue.

Goodbye ☮️

@github-actions github-actions bot changed the title Baffling headline: "ESP32-C3-LCDKit is...designed for wildlife protection." <-- ??? Baffling headline: "ESP32-C3-LCDKit is...designed for wildlife protection." <-- ??? (AEGHB-630) Apr 19, 2024
@Horion0415
Copy link

Horion0415 commented Apr 28, 2024

Thank you for raising the issue and providing the revisions. For the specific rationale behind the documentation's wording, you can refer to https://www.espressif.com/en/company/corporate-responsibility/wildlife-protection-program. Some of Espressif's new development boards will be named after endangered species. We will donate a portion of the proceeds from these development boards to the IUCN, hoping to protect more endangered species through our efforts.

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

No branches or pull requests

2 participants