feat(dx): Add Makefile and setup guide #13
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
| # This workflow checks for broken links in the built MkDocs site using mkdocs-htmlproofer-plugin. | |
| # It runs on every push and pull request to main and release branches. | |
| name: MkDocs Broken Link Check | |
| on: | |
| push: | |
| branches: | |
| - main | |
| - 'release/**' | |
| pull_request: | |
| branches: | |
| - main | |
| - 'release/**' | |
| jobs: | |
| link-check: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.10' | |
| - name: Install dependencies | |
| run: | | |
| pip install -r requirements.txt || true | |
| pip install mkdocs-htmlproofer-plugin | |
| - name: Build docs and check links | |
| run: | | |
| mkdocs build |