Skip to content
Documentation Validation

ci: add GitHub workflows for documentation validation and Mintlify checks #8

Sign in to view logs

ci: add GitHub workflows for documentation validation and Mintlify checks

ci: add GitHub workflows for documentation validation and Mintlify checks #8

Workflow file for this run

.github/workflows/docs-validation.yml at 979b1d7
name: Documentation Validation
on:
push:
branches:
- main
- master
pull_request:
branches:
- main
- master
workflow_dispatch:
jobs:
validate-docs:
name: Check for Errors and Broken Links
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v5
with:
fetch-depth: 0
- name: Setup Node.js
uses: actions/setup-node@v6
with:
node-version: '22'
- name: Install jq
run: sudo apt-get update && sudo apt-get install -y jq
- name: Install Mintlify CLI
run: npm install -g mintlify
- name: Run validation script
id: validate
run: |
echo "## 📚 Documentation Validation" >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
echo "Running validation checks using ./scripts/validate-docs.sh" >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
# Make script executable and run it
chmod +x ./scripts/validate-docs.sh
./scripts/validate-docs.sh