Style(repo): Fix documentation content according to the textlint rules #1588
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: 📄 Documentation Review | |
| on: | |
| # Run this workflow on push to branches only (not tags) | |
| push: | |
| branches: | |
| - '**' | |
| schedule: | |
| - cron: '0 9 * * *' # every day at 9:00 | |
| jobs: | |
| markdown-link-check: | |
| name: 🔗 Checking Markdown Links | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: gaurav-nelson/github-action-markdown-link-check@v1 | |
| with: | |
| use-verbose-mode: 'yes' | |
| config-file: '.github/markdown-link-check-config.json' | |
| continue-on-error: true | |
| markdown-lint: | |
| name: 📝 Linting Markdown | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 10 | |
| env: | |
| HUSKY: 0 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Setup Node and Install Dependencies | |
| uses: ./.github/actions/setup-install | |
| - name: Check File Format | |
| run: yarn lint:markdown | |
| text-lint: | |
| name: 📋 Linting Text | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 10 | |
| env: | |
| HUSKY: 0 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Setup Node and Install Dependencies | |
| uses: ./.github/actions/setup-install | |
| - name: Check Documentation Content | |
| run: yarn lint:text |