Detect typos in Markdown documents (project-chip#9284)

* Fix documentation's typos Signed-off-by: Victor Morales <[email protected]> * Add Spell checker CI action Signed-off-by: Victor Morales <[email protected]> * Configure GH actions to avoid running on documentation changes Signed-off-by: Victor Morales <[email protected]>
mkardous-silabs · Aug 30, 2021 · bcbda0d · bcbda0d
1 parent cb5e395
commit bcbda0d
Show file tree

Hide file tree

Showing 45 changed files with 1,141 additions and 58 deletions.
diff --git a/.github/.wordlist.txt b/.github/.wordlist.txt
diff --git a/.github/workflows/android.yaml b/.github/workflows/android.yaml
@@ -16,7 +16,11 @@ name: Android
 
 on:
     push:
+        paths:
+            - '!**.md'
     pull_request:
+        paths:
+            - '!**.md'
 
 concurrency:
     group: ${{ github.ref }}-${{ github.workflow }}-${{ (github.event_name == 'pull_request' && github.event.number) || (github.event_name == 'workflow_dispatch' && github.run_number) || github.sha }}

diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -16,7 +16,11 @@ name: Builds
 
 on:
     push:
+        paths:
+          - '!**.md'
     pull_request:
+        paths:
+          - '!**.md'
     workflow_dispatch:
 
 concurrency:

diff --git a/.github/workflows/cirque.yaml b/.github/workflows/cirque.yaml
@@ -16,7 +16,11 @@ name: Cirque
 
 on:
   push:
+    paths:
+      - '!**.md'
   pull_request:
+    paths:
+      - '!**.md'
   workflow_dispatch:
 
 concurrency:

diff --git a/.github/workflows/darwin.yaml b/.github/workflows/darwin.yaml
@@ -16,7 +16,11 @@ name: Darwin
 
 on:
     push:
+        paths:
+            - '!**.md'
     pull_request:
+        paths:
+            - '!**.md'
     workflow_dispatch:
 
 concurrency:

diff --git a/.github/workflows/doxygen.yaml b/.github/workflows/doxygen.yaml
@@ -16,7 +16,11 @@ name: Doxygen
 
 on:
     push:
+        paths:
+            - '!**.md'
     pull_request:
+        paths:
+            - '!**.md'
     workflow_dispatch:
 
 concurrency:

diff --git a/.github/workflows/examples-efr32.yaml b/.github/workflows/examples-efr32.yaml
@@ -16,7 +16,11 @@ name: Build example - EFR32
 
 on:
     push:
+        paths:
+            - '!**.md'
     pull_request:
+        paths:
+            - '!**.md'
 
 concurrency:
     group: ${{ github.ref }}-${{ github.workflow }}-${{ (github.event_name == 'pull_request' && github.event.number) || (github.event_name == 'workflow_dispatch' && github.run_number) || github.sha }}

diff --git a/.github/workflows/examples-esp32.yaml b/.github/workflows/examples-esp32.yaml
@@ -16,7 +16,11 @@ name: Build example - ESP32
 
 on:
     push:
+        paths:
+            - '!**.md'
     pull_request:
+        paths:
+            - '!**.md'
 
 concurrency:
     group: ${{ github.ref }}-${{ github.workflow }}-${{ (github.event_name == 'pull_request' && github.event.number) || (github.event_name == 'workflow_dispatch' && github.run_number) || github.sha }}

diff --git a/.github/workflows/examples-infineon.yaml b/.github/workflows/examples-infineon.yaml
@@ -16,7 +16,11 @@ name: Build example - Infineon P6
 
 on:
     push:
+        paths:
+          - '!**.md'
     pull_request:
+        paths:
+          - '!**.md'
     workflow_dispatch:
 
 concurrency:

diff --git a/.github/workflows/examples-k32w.yaml b/.github/workflows/examples-k32w.yaml
@@ -16,7 +16,11 @@ name: Build example - K32W with SE051
 
 on:
     push:
+        paths:
+            - '!**.md'
     pull_request:
+        paths:
+            - '!**.md'
 
 concurrency:
     group: ${{ github.ref }}-${{ github.workflow }}-${{ (github.event_name == 'pull_request' && github.event.number) || (github.event_name == 'workflow_dispatch' && github.run_number) || github.sha }}

diff --git a/.github/workflows/examples-linux-standalone.yaml b/.github/workflows/examples-linux-standalone.yaml
@@ -16,7 +16,11 @@ name: Build example - Linux Standalone
 
 on:
     push:
+        paths:
+            - '!**.md'
     pull_request:
+        paths:
+            - '!**.md'
 
 concurrency:
     group: ${{ github.ref }}-${{ github.workflow }}-${{ (github.event_name == 'pull_request' && github.event.number) || (github.event_name == 'workflow_dispatch' && github.run_number) || github.sha }}

diff --git a/.github/workflows/examples-nrfconnect.yaml b/.github/workflows/examples-nrfconnect.yaml
@@ -16,7 +16,11 @@ name: Build example - nRF Connect SDK
 
 on:
     push:
+        paths:
+            - '!**.md'
     pull_request:
+        paths:
+            - '!**.md'
 
 concurrency:
     group: ${{ github.ref }}-${{ github.workflow }}-${{ (github.event_name == 'pull_request' && github.event.number) || (github.event_name == 'workflow_dispatch' && github.run_number) || github.sha }}

diff --git a/.github/workflows/examples-qpg.yaml b/.github/workflows/examples-qpg.yaml
@@ -16,7 +16,11 @@ name: Build example - QPG
 
 on:
     push:
+        paths:
+            - '!**.md'
     pull_request:
+        paths:
+            - '!**.md'
 
 concurrency:
     group: ${{ github.ref }}-${{ github.workflow }}-${{ (github.event_name == 'pull_request' && github.event.number) || (github.event_name == 'workflow_dispatch' && github.run_number) || github.sha }}

diff --git a/.github/workflows/examples-telink.yaml b/.github/workflows/examples-telink.yaml
@@ -16,7 +16,11 @@ name: Build example - Telink
 
 on:
     push:
+        paths:
+            - '!**.md'
     pull_request:
+        paths:
+            - '!**.md'
 
 concurrency:
     group: ${{ github.ref }}-${{ github.workflow }}-${{ (github.event_name == 'pull_request' && github.event.number) || (github.event_name == 'workflow_dispatch' && github.run_number) || github.sha }}

diff --git a/.github/workflows/qemu.yaml b/.github/workflows/qemu.yaml
@@ -16,7 +16,11 @@ name: QEMU
 
 on:
     push:
+        paths:
+            - '!**.md'
     pull_request:
+        paths:
+            - '!**.md'
 
 concurrency:
     group: ${{ github.ref }}-${{ github.workflow }}-${{ (github.event_name == 'pull_request' && github.event.number) || (github.event_name == 'workflow_dispatch' && github.run_number) || github.sha }}

diff --git a/.github/workflows/spell.yml b/.github/workflows/spell.yml
@@ -0,0 +1,41 @@
+# Copyright (c) 2020-2021 Project CHIP Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: Run misspell
+# yamllint disable-line rule:truthy
+on:
+  push:
+    paths:
+      - '**.md'
+      - '!.github/*'
+  pull_request:
+    branches:
+      - master
+    paths:
+      - '**.md'
+      - '!.github/*'
+
+jobs:
+  check-reviewdog:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: reviewdog/action-misspell@v1
+        with:
+          github_token: ${{ secrets.github_token }}
+  check-spellcheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: igsekor/[email protected]
diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml
@@ -16,7 +16,11 @@ name: Tests
 
 on:
     push:
+        paths:
+            - '!**.md'
     pull_request:
+        paths:
+            - '!**.md'
     workflow_dispatch:
 
 concurrency:

diff --git a/.github/workflows/unit_integration_test.yaml b/.github/workflows/unit_integration_test.yaml
@@ -16,7 +16,11 @@ name: Unit / Interation Tests
 
 on:
     push:
+        paths:
+            - '!**.md'
     pull_request:
+        paths:
+            - '!**.md'
 
 concurrency:
     group: ${{ github.ref }}-${{ github.workflow }}-${{ (github.event_name == 'pull_request' && github.event.number) || (github.event_name == 'workflow_dispatch' && github.run_number) || github.sha }}

diff --git a/.github/workflows/zap_templates.yaml b/.github/workflows/zap_templates.yaml
@@ -16,7 +16,11 @@ name: ZAP
 
 on:
     push:
+        paths:
+            - '!**.md'
     pull_request:
+        paths:
+            - '!**.md'
 
 concurrency:
     group: ${{ github.ref }}-${{ github.workflow }}-${{ (github.event_name == 'pull_request' && github.event.number) || (github.event_name == 'workflow_dispatch' && github.run_number) || github.sha }}

diff --git a/.spellcheck.yml b/.spellcheck.yml
@@ -0,0 +1,25 @@
+# Copyright (c) 2020-2021 Project CHIP Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+matrix:
+  - name: markdown
+    dictionary:
+      wordlists:
+        - .github/.wordlist.txt
+    pipeline:
+      - pyspelling.filters.markdown:
+    sources:
+      - '**/*.md|!third_party/**|!examples/common/**/repo/**'
+    aspell:
+      ignore-case: true
diff --git a/docs/VSCODE_DEVELOPMENT.md b/docs/VSCODE_DEVELOPMENT.md
@@ -85,7 +85,7 @@ session.
 
 Developers are encouraged to add tasks to the
 [launch json](../.vscode/launch.json) over time to make sure everyone is using
-the same base debuging setup.
+the same base debugging setup.
 
 ## Submitting a Pull Request - Practical Advice
 

diff --git a/docs/guides/nrfconnect_examples_configuration.md b/docs/guides/nrfconnect_examples_configuration.md
@@ -107,7 +107,7 @@ them default values for any application.
 
 The application configuration is specified using Kconfig configuration files
 (`*.conf`), where available Kconfig options can be used and their default values
-overrided. Typically, there are many files having impact on the final
+overridden. Typically, there are many files having impact on the final
 configuration shape.
 
 There is no need to modify all these files separately. See the following list

diff --git a/docs/guides/nxp_k32w_android_commissioning.md b/docs/guides/nxp_k32w_android_commissioning.md
@@ -27,7 +27,7 @@ onto a CHIP-enabled Thread network.
 
 The commissioning process is composed of the following main stages:
 
--   K32W061 (CHIP accessory) device is put in BLE advertisment mode by pressing
+-   K32W061 (CHIP accessory) device is put in BLE advertisement mode by pressing
     the USERINTERFACE button;
 -   CHIPTool discovers the CHIP accessory over BLE;
 -   CHIPTool establishes a secure channel with the accessory using a SPAKE2+
@@ -182,7 +182,7 @@ To make your PC work as a Thread Border Router, complete the following tasks:
 
     -   On System startup, dnsmasq will not wait for wlan0 interface to
         initialize and will fail. We need to tell systemd to launch it after
-        networks get ready, so we will modify dnsmasq service file by specifing
+        networks get ready, so we will modify dnsmasq service file by specifying
         the initialization order under the _After=_ and _Wants=_ sections:
 
               $ sudo vim /lib/systemd/system/dnsmasq.service

diff --git a/docs/guides/python_chip_controller_advanced_usage.md b/docs/guides/python_chip_controller_advanced_usage.md
@@ -110,7 +110,7 @@ Reading symbols from python3...
 ```
 
 The Python will create lots of threads due to main loop, so you may want to
-supress thread related outputs first by running the following command:
+suppress thread related outputs first by running the following command:
 
 ```
 (gdb) set print thread-events off
@@ -247,4 +247,4 @@ then you can use `bt` (for `backtrace`) to see the backtrace of the call stack.
 ```
 
 The frame #0 and frame #1 are the function frames in the CHIP C++ library, the
-other frames live in the Python intepreter so you can ignore it.
+other frames live in the Python interpreter so you can ignore it.
diff --git a/docs/guides/python_chip_controller_building.md b/docs/guides/python_chip_controller_building.md
@@ -223,7 +223,7 @@ with network credentials.
         Done
         ```
 
-    Matter specifiction does not define how the Thread or Wi-Fi credentials are
+    Matter specification does not define how the Thread or Wi-Fi credentials are
     obtained by Controller. For example, for Thread, instead of fetching
     datasets directly from the Thread Border Router, you might also use a
     different out-of-band method.
@@ -248,7 +248,7 @@ with network credentials.
 #### Commissioning a Wi-Fi device
 
 1. Assuming your Wi-Fi SSID is _TESTSSID_, and your Wi-Fi password is
-   _P455W4RD_, inject the credentials to the device by excuting the following
+   _P455W4RD_, inject the credentials to the device by executing the following
    command:
 
     ```
@@ -396,7 +396,7 @@ If no nodeid given, a random Node ID will be used.
 
 ### `close-session <nodeid>`
 
-If case there eixsts an open session (PASE or CASE) to the device with a given
+If case there exists an open session (PASE or CASE) to the device with a given
 Node ID, mark it as expired.
 
 ### `discover`
@@ -470,7 +470,7 @@ chip-device-ctrl > zcl LevelControl MoveWithOnOff 12344321 1 0 moveMode=1 rate=2
 For any integer and char string (null terminated) types, just use `key=value`,
 for example: `rate=2`, `string=123`, `string_2="123 456"`
 
-For byte string type, use `key=encoding:value`, currectly, we support `str` and
+For byte string type, use `key=encoding:value`, currently, we support `str` and
 `hex` encoding, the `str` encoding will encode a NULL terminated string. For
 example, `networkId=hex:0123456789abcdef` (for
 `[0x01, 0x23, 0x45, 0x67, 0x89, 0xab, 0xcd, 0xef]`), `ssid=str:Test` (for

diff --git a/examples/all-clusters-app/esp32/README.md b/examples/all-clusters-app/esp32/README.md
@@ -220,7 +220,7 @@ commissioning and cluster control.
 
     `chip-device-ctrl > zcl LevelControl MoveToLevel 135246 1 1 level=10 transitionTime=0 optionMask=0 optionOverride=0`
 
--   For ESP32C3-DevKitM, use the ColorContorl cluster commands to control the
+-   For ESP32C3-DevKitM, use the ColorControl cluster commands to control the
     CurrentHue and CurrentSaturation attribute. This allows you to control the
     color of on-board LED.
 

diff --git a/examples/lighting-app/efr32/README.md b/examples/lighting-app/efr32/README.md
@@ -215,7 +215,7 @@ combination with JLinkRTTClient as follows:
 
         -   _Press and Release_ : Start, or restart, BLE advertisement in fast mode. It will advertise in this mode
             for 30 seconds. The device will then switch to a slower interval advertisement.
-            After 15 minutes, the adverstiment stops.
+            After 15 minutes, the advertisement stops.
 
         -   _Pressed and hold for 6 s_ : Initiates the factory reset of the device.
             Releasing the button within the 6-second window cancels the factory reset
@@ -289,7 +289,7 @@ via 2002::2
 -   To use the chip-rpc console after it has been installed run:
     `python3 -m chip_rpc.console --device /dev/tty.<SERIALDEVICE> -b 115200 -o /<YourFolder>/pw_log.out`
 
--   Then you can simulate a button press or realease using the following command
+-   Then you can simulate a button press or release using the following command
     where : idx = 0 or 1 for Button PB0 or PB1 action = 0 for PRESSED, 1 for
     RELEASE Test toggling the LED with
     `rpcs.chip.rpc.Button.Event(idx=1, pushed=True)`

diff --git a/examples/lighting-app/nxp/linux-imx/imx8m/README.md b/examples/lighting-app/nxp/linux-imx/imx8m/README.md
@@ -155,7 +155,7 @@ The generated executable file supports to work with below commandline argument:
 -   Prerequisites
 
     By following the [Building](#building) section of this document, the Yocto
-    image is cross-compiled and programed to a microSD card.
+    image is cross-compiled and programmed to a microSD card.
 
     Follow the steps below to setup the environment needed to run the example on
     the i.MX 8M Mini EVK: