check_docs.yml

name: Check documentation
on:
  pull_request:
    paths:
      - 'docs/**'
      - '.github/workflows/check_docs.yml'

jobs:

  markdownlint:
    name: Validate markdown
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@master

      - name: Lint
        uses: reviewdog/action-markdownlint@v0
        with:
          github_token: ${{ secrets.github_token }}
          reporter: github-pr-review
          fail_on_error: true
          markdownlint_flags: "--config ./docs/.markdownlint.yml ./docs/src"

  spellcheck:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@master

      - name: spellcheck
        uses: reviewdog/action-misspell@v1
        with:
          github_token: ${{ secrets.github_token }}
          reporter: github-pr-review
          fail_on_error: true
          locale: "US"
          path: ./docs/src/
          pattern: "*.md"
          filter_mode: nofilter