Merge pull request #338 from Ganymede-Bio/carusooo/spell-check

Add spell check to docs

.github/workflows/pr-check.yaml

@@ -0,0 +1,35 @@
+name: Pull Request Checks
+
+on:
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  spellcheck:
+    name: Spellcheck
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/[email protected]
+      name: Checkout
+    - id: changed_files
+      name: Changed Files
+      uses: tj-actions/changed-files@v45
+      with:
+        files: |
+           **.mdx
+    - name: List all changed files
+      env:
+        ALL_CHANGED_FILES: ${{ steps.changed_files.outputs.all_changed_files }}
+      run: |
+        for file in ${ALL_CHANGED_FILES}; do
+        echo "$file was changed"
+        done
+    - uses: rojopolis/[email protected]
+      name: Spellcheck
+      if: ${{ steps.changed_files.outputs.all_changed_files }}
+      with:
+        source_files: ${{ steps.changed_files.outputs.all_changed_files }}
+        task_name: Markdown

.wordlist.txt

@@ -0,0 +1,6 @@
+ganymede
+UI
+performant
+releaseSideBar
+SDK
+MSI

README.md

@@ -142,6 +142,11 @@ popd
 
 To add images, drop them into [this GCS bucket](https://console.cloud.google.com/storage/browser/ganymede-bio-website/public;tab=objects?project=ganymede-website-356920&pageState=(%22StorageObjectListTable%22:(%22f%22:%22%255B%255D%22))&prefix=&forceOnObjectsSortingFiltering=false)
 
+
+### Spellchecking
+
+To add new words to the allowed list, update `.wordlist.txt`.
+
 ---
 
 ## License

spellcheck.yaml

@@ -0,0 +1,20 @@
+matrix:
+- name: Markdown
+  aspell:
+    lang: en
+  dictionary:
+    wordlists:
+    - .wordlist.txt
+    encoding: utf-8
+  pipeline:
+  - pyspelling.filters.markdown:
+      markdown_extensions:
+      - pymdownx.superfences
+  - pyspelling.filters.html:
+      comments: false
+      ignores:
+      - code
+      - pre
+  sources:
+  - '**/*.mdx'
+  default_encoding: utf-8