Add codespell for docs directory

ingonyama-zk · Jan 21, 2024 · b3b27e0 · b3b27e0
1 parent 14e4b53
commit b3b27e0
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 1 deletion.
diff --git a/.codespellignore b/.codespellignore
@@ -0,0 +1 @@
+ICICLE
diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml
@@ -0,0 +1,18 @@
+name: Check Spelling
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  spelling-checker:
+    name: Check Spelling
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: codespell-project/actions-codespell@v2
+        with:
+          path: docs
+          # https://github.com/codespell-project/actions-codespell?tab=readme-ov-file#parameter-ignore_words_file
+          ignore_words_file: .codespellignore
diff --git a/docs/icicle/colab-instructions.md b/docs/icicle/colab-instructions.md
@@ -82,7 +82,7 @@ Wed Jan 17 13:10:18 2024
 +---------------------------------------------------------------------------------------+
 ```
 
-## Clonig ICICLE and running test
+## Cloning ICICLE and running test
 
 Now we are ready to clone ICICE repository,
-Original file line number
+Diff line change
@@ Expand Up / @@ -82,7 +82,7 @@ Wed Jan 17 13:10:18 2024 @@
     +---------------------------------------------------------------------------------------+
     ```
-    ## Clonig ICICLE and running test
+    ## Cloning ICICLE and running test
     Now we are ready to clone ICICE repository,
@@ Expand Down @@