From e1eb6f1022d4f12b9000e50e91189fbeb1cc0e42 Mon Sep 17 00:00:00 2001
From: Nikhil Parikh <46944981+maybenikhil@users.noreply.github.com>
Date: Mon, 26 Feb 2024 17:21:54 -0800
Subject: [PATCH] added spellcheck

---
 .github/workflows/spellcheck.yml | 14 ++++++++++++++
 .spellcheck.yml                  | 27 +++++++++++++++++++++++++++
 .wordlist.txt                    |  0
 3 files changed, 41 insertions(+)
 create mode 100644 .github/workflows/spellcheck.yml
 create mode 100644 .spellcheck.yml
 create mode 100644 .wordlist.txt

diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml
new file mode 100644
index 000000000..92080e083
--- /dev/null
+++ b/.github/workflows/spellcheck.yml
@@ -0,0 +1,14 @@
+name: spellcheck
+on:
+  pull_request:
+jobs:
+  check-spelling:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Check Spelling
+        uses: rojopolis/spellcheck-github-actions@0.23.0
+        with:
+          config_path: .spellcheck.yml
+          task_name: Markdown
diff --git a/.spellcheck.yml b/.spellcheck.yml
new file mode 100644
index 000000000..7de4cd709
--- /dev/null
+++ b/.spellcheck.yml
@@ -0,0 +1,27 @@
+matrix:
+- name: Markdown
+  expect_match: false
+  apsell:
+    mode: en
+  dictionary:
+    wordlists:
+    - .wordlist.txt
+    output: wordlist.dic
+    encoding: utf-8
+  pipeline:
+  - pyspelling.filters.markdown:
+      markdown_extensions:
+      - markdown.extensions.extra:
+  - pyspelling.filters.html:
+      comments: false
+      attributes:
+      - alt
+      ignores:
+      - ':matches(code, pre)'
+      - 'code'
+      - 'pre'
+      - 'blockquote'
+  sources:
+  - 'docs/**/**/*.md'
+  - 'docs/**/*.md'
+  - 'docs/*.md'
diff --git a/.wordlist.txt b/.wordlist.txt
new file mode 100644
index 000000000..e69de29bb