From 7c9da0643d281171bfecef8f04962e2090a1ad6d Mon Sep 17 00:00:00 2001 From: KaifAhmad1 Date: Fri, 22 May 2026 23:01:31 +0530 Subject: [PATCH] ci: replace MkDocs build workflow with Mintlify docs validation - docs.yml: replace mkdocs build/deploy with python docs_check.py; Mintlify deployment is handled by its own GitHub App - ci.yml: remove dead paths-ignore refs to deleted mkdocs.yml and requirements-docs.txt --- .github/workflows/ci.yml | 6 ++-- .github/workflows/docs.yml | 59 ++++++-------------------------------- 2 files changed, 11 insertions(+), 54 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 994503ad..d53f95c1 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -5,15 +5,13 @@ on: branches: [main] paths-ignore: - 'docs/**' - - 'mkdocs.yml' - - 'requirements-docs.txt' + - 'docs_check.py' - '**/*.md' pull_request: branches: [main] paths-ignore: - 'docs/**' - - 'mkdocs.yml' - - 'requirements-docs.txt' + - 'docs_check.py' - '**/*.md' jobs: diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 36bb4f1c..7e1b4394 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1,35 +1,30 @@ name: Build and Deploy Documentation -# This workflow builds the documentation site and deploys it to GitHub Pages -# It runs when changes are pushed to the 'docs' folder on the main branch - on: push: branches: [main] paths: - 'docs/**' - - 'mkdocs.yml' - - 'requirements-docs.txt' + - 'docs_check.py' - 'CHANGELOG.md' - 'RELEASE.md' - release: - types: [published] + pull_request: + branches: [main] + paths: + - 'docs/**' + - 'docs_check.py' workflow_dispatch: -# Permissions needed to deploy to GitHub Pages permissions: contents: read - pages: write - id-token: write -# Prevent concurrent deployments concurrency: group: "pages" cancel-in-progress: false jobs: build: - name: Build Documentation + name: Validate Documentation runs-on: ubuntu-latest steps: - name: Checkout code @@ -40,41 +35,5 @@ jobs: with: python-version: '3.11' - - name: Install documentation dependencies - run: | - python -m pip install --upgrade pip - pip install -r requirements-docs.txt - - - name: Build documentation - # Builds the static site using MkDocs - run: mkdocs build --strict - - - name: Check for broken links - # Optional: checks if any links in the docs are broken - run: | - pip install linkchecker || echo "Skipping link check" - if [ -d "site" ]; then - linkchecker site/ --check-extern || echo "Link check completed" - fi - continue-on-error: true - - - name: Setup Pages - uses: actions/configure-pages@v6 - continue-on-error: true - - - name: Upload artifact - uses: actions/upload-pages-artifact@v5 - with: - path: ./site - - deploy: - name: Deploy to GitHub Pages - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} - runs-on: ubuntu-latest - needs: build - steps: - - name: Deploy to GitHub Pages - id: deployment - uses: actions/deploy-pages@v5 + - name: Validate documentation + run: python docs_check.py