Skip to content

Conversation

f-hollow
Copy link
Collaborator

Description

This PR adds a Vale configuration and Espressif rules to lint the content in English.

The results of some checks can be seen in the Files tab > README.md.

In issue .vale/styles/Espressif-devportal.TermsFixedPattern, we need to agree on how to refer to Espressif / ESP / ESP32 chips or devices or products...

Related

Testing

Testing has been done in testing environments 1 and 2.


Checklist

Before submitting a Pull Request, please ensure the following:

  • 🚨 This PR does not introduce breaking changes.
  • All CI checks (GH Actions) pass.
  • Documentation is updated as needed.
  • Tests are updated or added as necessary.
  • Code is well-commented, especially in complex areas.
  • Git history is clean — commits are squashed to the minimum necessary.

@f-hollow f-hollow force-pushed the feat/lint_using_vale branch from 0138eb3 to 352c1c3 Compare March 21, 2025 12:13
@pedrominatel
Copy link
Member

Thank you @f-hollow for preparing this PR.
There are more terms and acronyms to be added, but we can do it in a new PR after testing this.

@f-hollow f-hollow force-pushed the feat/lint_using_vale branch 2 times, most recently from 701cae2 to 6bbd45b Compare March 28, 2025 04:15
@f-hollow f-hollow force-pushed the feat/lint_using_vale branch from 6bbd45b to 0b155ff Compare March 28, 2025 10:59
@f-hollow f-hollow force-pushed the feat/lint_using_vale branch from 0b155ff to 46e6d02 Compare March 28, 2025 11:29
@f-hollow f-hollow force-pushed the feat/lint_using_vale branch 2 times, most recently from 0fd5f8b to 7966dfe Compare March 28, 2025 11:43
Copy link

🎉 A preview for this PR is available at: https://preview-developer.espressif.com/pr447/

@f-hollow f-hollow added the Status: In Progress Issue is being worked on label Apr 27, 2025
@f-hollow f-hollow added the Status: Draft Content writing in PR is not finished yet label Jul 10, 2025
@f-hollow f-hollow marked this pull request as draft July 10, 2025 04:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Draft Content writing in PR is not finished yet Status: In Progress Issue is being worked on
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants