docs(vale): Enable vale and fix errors

Author: lucasssvaz

.pre-commit-config.yaml

@@ -1,7 +1,8 @@
 exclude: |
   (?x)(
       ^\.github\/|
-      ^tests\/performance\/coremark\/.*\.[ch]$
+      ^tests\/performance\/coremark\/.*\.[ch]$|
+      LICENSE\.md$
   )
 
 default_language_version:
@@ -64,8 +65,6 @@ repos:
         pass_filenames: false
         args: [sync]
         types_or: [markdown, rst]
-        stages: [manual]
       - id: vale
         language_version: "1.21.6"
         types_or: [markdown, rst]
-        stages: [manual]

.vale.ini

@@ -23,7 +23,7 @@ StylesPath = .vale/styles
 
 
 # Specify the minimum alert severity that Vale will report.
-MinAlertLevel = suggestion # "suggestion", "warning", or "error"
+MinAlertLevel = error # "suggestion", "warning", or "error"
 
 
 # Specify vocabulary for special treatment.

docs/en/api/adc.rst

@@ -53,7 +53,7 @@ analogReadResolution
 ^^^^^^^^^^^^^^^^^^^^
 
 This function is used to set the resolution of ``analogRead`` return value. Default is 12 bits (range from 0 to 4095)
-for all chips except ESP32S3 where default is 13 bits (range from 0 to 8191).
+for all chips except ESP32-S3 where default is 13 bits (range from 0 to 8191).
 When different resolution is set, the values read will be shifted to match the given resolution.
 
 Range is 1 - 16 .The default value will be used, if this function is not used.
@@ -146,7 +146,7 @@ analogSetWidth
 .. note:: This function is only available for ESP32 chip.
 
 This function is used to set the hardware sample bits and read resolution.
-Default is 12bit (0 - 4095).
+Default is 12 bits (0 - 4095).
 Range is 9 - 12.
 
 .. code-block:: arduino
@@ -250,13 +250,13 @@ This function is used to set the attenuation for ADC continuous peripheral. For
 
     void analogContinuousSetAtten(adc_attenuation_t attenuation);
 
-* ``attenuation`` sets the attenuation (default is 11db).
+* ``attenuation`` sets the attenuation (default is 11 dB).
 
 analogContinuousSetWidth
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
 This function is used to set the hardware resolution bits.
-Default value for all chips is 12bit (0 - 4095).
+Default value for all chips is 12 bits (0 - 4095).
 
 .. note:: This function will take effect only for ESP32 chip, as it allows to set resolution in range 9-12 bits.
 

docs/en/api/dac.rst

@@ -33,7 +33,7 @@ This function is used to set the DAC value for a given pin/DAC channel.
     void dacWrite(uint8_t pin, uint8_t value);
 
 * ``pin`` GPIO pin.
-* ``value`` to be set. Range is 0 - 255 (equals 0V - 3.3V).
+* ``value`` to be set. Range is 0 - 255 (equals 0 V - 3.3 V).
 
 dacDisable
 **********

docs/en/api/espnow.rst

@@ -104,7 +104,7 @@ Create an instance of the `ESP_NOW_Peer` class.
 
 * ``mac_addr``: MAC address of the peer device.
 * ``channel``: Communication channel.
-* ``iface``: WiFi interface.
+* ``iface``: Wi-Fi interface.
 * ``lmk``: Optional. Pass the local master key (LMK) if encryption is enabled.
 
 add
@@ -190,24 +190,24 @@ Set the communication channel of the peer.
 getInterface
 ^^^^^^^^^^^^
 
-Get the WiFi interface of the peer.
+Get the Wi-Fi interface of the peer.
 
 .. code-block:: cpp
 
     wifi_interface_t getInterface() const;
 
-Returns the WiFi interface.
+Returns the Wi-Fi interface.
 
 setInterface
 ^^^^^^^^^^^^
 
-Set the WiFi interface of the peer.
+Set the Wi-Fi interface of the peer.
 
 .. code-block:: cpp
 
     void setInterface(wifi_interface_t iface);
 
-* ``iface``: WiFi interface.
+* ``iface``: Wi-Fi interface.
 
 isEncrypted
 ^^^^^^^^^^^

docs/en/api/i2c.rst

@@ -103,7 +103,7 @@ This function will return the current frequency configuration.
 setTimeOut
 ^^^^^^^^^^
 
-Set the bus timeout given in milliseconds. The default value is 50ms.
+Set the bus timeout given in milliseconds. The default value is 50 ms.
 
 .. code-block:: arduino
 

docs/en/api/insights.rst

@@ -5,7 +5,7 @@ ESP Insights
 About
 -----
 
-ESP Insights is a remote diagnostics solution that allows users to remotely monitor the health of ESP devices in the field.
+ESP Insights is a remote diagnostics solution that allows users to remotely monitor the health of Espressif devices in the field.
 
 Developers normally prefer debugging issues by physically probing them using gdb or observing the logs. This surely helps debug issues, but there are often cases wherein issues are seen only in specific environments under specific conditions. Even things like casings and placement of the product can affect the behavior. A few examples are
 
@@ -156,8 +156,8 @@ This function will return
 Insights.metrics.dumpWiFi
 *************************
 
-Dumps the wifi metrics and prints them to the console.
-This API can be used to collect wifi metrics at any given point in time.
+Dumps the Wi-Fi metrics and prints them to the console.
+This API can be used to collect Wi-Fi metrics at any given point in time.
 
 .. code-block:: arduino
 
@@ -185,8 +185,8 @@ Insights.metrics.setWiFiPeriod
 ******************************
 
 Reset the periodic interval
-By default, wifi metrics are collected every 30 seconds, this function can be used to change the interval.
-If the interval is set to 0, wifi metrics collection disabled.
+By default, Wi-Fi metrics are collected every 30 seconds, this function can be used to change the interval.
+If the interval is set to 0, Wi-Fi metrics collection disabled.
 
 .. code-block:: arduino
 

docs/en/api/rainmaker.rst

@@ -29,7 +29,7 @@ ESP RainMaker Agent API
 RMaker.initNode
 ***************
 
-This initializes the ESP RainMaker agent, wifi and creates the node.
+This initializes the ESP RainMaker agent, Wi-Fi and creates the node.
 
 You can also set the configuration of the node using the following API
 
@@ -54,7 +54,7 @@ It starts the ESP RainMaker agent.
 **NOTE**:
 
 1. ESP RainMaker agent should be initialized before this call.
-2. Once ESP RainMaker agent starts, compulsorily call WiFi.beginProvision() API.
+2. Once ESP RainMaker agent starts, compulsorily call ``WiFi.beginProvision()`` API.
 
 .. code-block:: arduino
 

docs/en/api/touch.rst

@@ -36,7 +36,7 @@ touchSetCycles
 ^^^^^^^^^^^^^^
 
 This function is used to set cycles that measurement operation takes. The result from touchRead, threshold and detection accuracy depend on these values.
-The defaults are setting touchRead to take ~0.5ms.
+The defaults are setting touchRead to take ~0.5 ms.
 
 .. code-block:: arduino
 
@@ -112,8 +112,8 @@ the threshold value. Default is lower.
 
     void touchInterruptSetThresholdDirection(bool mustbeLower);
 
-TOUCH API specific for ESP32S2 and ESP32S3 chip (TOUCH_V2)
-**********************************************************
+TOUCH API specific for ESP32-S2 and ESP32-S3 chip (TOUCH_V2)
+************************************************************
 
 touchInterruptGetLastStatus
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^

docs/en/api/usb.rst

@@ -154,7 +154,7 @@ Get the USB power configuration.
 
     uint16_t usbPower(void);
 
-Return the current in mA. The default value is: ``0x500`` (500mA).
+Return the current in mA. The default value is: ``0x500`` (500 mA).
 
 usbClass
 ^^^^^^^^