Skip to content

Fix outline layout in docs and typos in docs #762

Fix outline layout in docs and typos in docs

Fix outline layout in docs and typos in docs #762

on:
workflow_dispatch:
pull_request:
branches:
- main
name: "Check spelling, linting and links"
jobs:
check-markdown:
runs-on: ubuntu-latest
name: "Check spelling, linting and links"
steps:
- uses: actions/checkout@v2
- run: |
# we download the config files from the org repo and pick up the rules from the latest main
wget https://github.com/qir-alliance/.github/archive/refs/heads/main.zip -O clone.zip &&
unzip clone.zip && mv .github-main out && rm clone.zip &&
mv out/workflow-templates/utils/ utils && rm -r out
shell: bash
- run: |
Get-ChildItem (Join-Path "utils" "problem-matchers") `
| ForEach-Object {
Write-Host "Adding matcher $_...";
Write-Host "::add-matcher::$_";
}
shell: pwsh
- name: markdownlint-cli
# cspell:words nosborn
uses: nosborn/[email protected]
with:
files: .
config_file: "utils/md_lint_config.yml"
- name: Markdown link check
# cspell:words gaurav
uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
use-verbose-mode: "yes"
config_file: "utils/mlc_config.json"
if: ${{ success() || failure() }}
- name: "Check spelling in changed files"
# cspell:words streetsidesoftware
uses: streetsidesoftware/[email protected]
with:
inline: warning
# Only warn on spelling errors, since there's likely a lot of false
# positives with terminology in quantum computing.
strict: false
incremental_files_only: true
config: "utils/spelling_allowlist.json"