Rename gcbm_view to gcbm_assistant #5
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: Docs Quality | |
| on: | |
| pull_request: | |
| paths: | |
| - "README.md" | |
| - "docs/**" | |
| - "mkdocs.yml" | |
| - "scripts/check_docs_anchors.py" | |
| - ".markdownlint-cli2.yaml" | |
| - ".github/workflows/docs-quality.yml" | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| jobs: | |
| docs-quality: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.11" | |
| - name: Install docs dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install mkdocs==1.6.1 mkdocs-material==9.7.3 pymdown-extensions==10.21 requests==2.32.3 | |
| - name: Anchor and internal link check | |
| run: python scripts/check_docs_anchors.py | |
| - name: Build docs site (strict) | |
| run: mkdocs build --strict --site-dir site | |
| - name: Setup Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: "20" | |
| - name: Install markdownlint-cli2 | |
| run: npm install -g markdownlint-cli2 | |
| - name: Markdown style check | |
| run: markdownlint-cli2 "README.md" "docs/**/*.md" | |
| - name: External link check | |
| uses: lycheeverse/lychee-action@v2 | |
| with: | |
| args: --verbose --no-progress --accept 200,206,429 README.md docs/**/*.md | |
| fail: true | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |