docs: add core concepts, resources, support and more #243
Workflow file for this run
This file contains hidden or 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: Test Docs | |
| on: | |
| push: | |
| branches: [main] | |
| paths: | |
| - "docs/**" | |
| pull_request: | |
| branches: [main] | |
| paths: | |
| - "docs/**" | |
| jobs: | |
| vale: | |
| name: Spell Check with Vale | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Vale | |
| uses: errata-ai/vale-action@v2 | |
| with: | |
| files: '["docs"]' | |
| vale_flags: "--config=docs/.vale.ini" | |
| fail_on_error: true | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| broken-links: | |
| name: Check Broken Links | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Setup Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: "22" | |
| - name: Cache npx packages | |
| uses: actions/cache@v4 | |
| with: | |
| path: ~/.npm/_npx | |
| key: ${{ runner.os }}-npx-mint-4.1.57 | |
| restore-keys: | | |
| ${{ runner.os }}-npx-mint- | |
| - name: Check for broken links | |
| working-directory: docs | |
| run: | | |
| output=$(npx --yes mint@4.1.57 broken-links) | |
| echo "$output" | |
| if echo "$output" | grep -q "found.*broken links"; then | |
| exit 1 | |
| fi |