Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add spell check to docs #338

Merged
merged 16 commits into from
Aug 23, 2024
35 changes: 35 additions & 0 deletions .github/workflows/pr-check.yaml
Original file line number Diff line number Diff line change
@@ -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
6 changes: 6 additions & 0 deletions .wordlist.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
ganymede
UI
performant
releaseSideBar
SDK
MSI
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion core-operators
20 changes: 20 additions & 0 deletions spellcheck.yaml
Original file line number Diff line number Diff line change
@@ -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
Loading