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
This commit is contained in:
KaifAhmad1
2026-05-22 23:01:31 +05:30
parent 5f124cd9f0
commit 7c9da0643d
2 changed files with 11 additions and 54 deletions
+2 -4
View File
@@ -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:
+9 -50
View File
@@ -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