Open nativeit opened 3 months ago
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.
Answers checklist.
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):
Links
fc52034
by @Lzw655Questions & 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):
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 :peace_symbol: