ci: move action to spellcheck CI workflow + adjust files to check

.github/workflows/ci.yml

@@ -30,12 +30,6 @@ jobs:
       - name: Prettier 🎨
         run: yarn run prettier
 
-      - name: Check spelling errors in code snippets 🔍
-        uses: codespell-project/actions-codespell@v2
-        with:
-          check_filenames: true
-          check_hidden: true
-
       - name: Build 🧱
         run: yarn run build
 

.github/workflows/spellcheck.yml

@@ -1,10 +1,12 @@
 # This workflow checks for common grammar and spelling mistake in markdown docs files.
 name: Spellcheck
-on: workflow_dispatch
+on:
+  pull_request:
+    branches: [main]
 
 jobs:
   build:
-    name: Spellcheck
+    name: Check Grammar and Spelling errors
     runs-on: ubuntu-latest
     steps:
       - name: Checkout 🛎️
@@ -15,12 +17,22 @@ jobs:
       - name: Install ⚙️
         run: yarn install --frozen-lockfile
 
-      - name: Spellcheck 📝
-        uses: rojopolis/[email protected]
+      # - name: Check spelling errors in docs content 📝
+      #   uses: rojopolis/[email protected]
+      #   with:
+      #     source_files: docs/**/*.md docs/**/*.mdx
+      #     task_name: Markdown
+      #     output_file: spellcheck-output.txt
+
+      - name: Check spelling errors in code snippets 🔍
+        # Spellcheck can also check code snippets but has limited support for some languages
+        # Solidity code seems to not be supported.
+        # See: https://github.com/rojopolis/spellcheck-github-actions
+        uses: codespell-project/actions-codespell@v2
         with:
-          source_files: docs/**/*.md docs/**/*.mdx
-          task_name: Markdown
-          output_file: spellcheck-output.txt
+          check_filenames: true
+          check_hidden: true
+          skip: yarn.lock,./node_modules/**/*,./yarn/**/*
 
       - name: Output Spellcheck Results 📝
         uses: actions/upload-artifact@v3