Merge remote-tracking branch 'origin/main' #22
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: Documentation Validation | |
| on: | |
| push: | |
| paths: | |
| - 'docs/**' | |
| - 'README.md' | |
| - '*.md' | |
| pull_request: | |
| paths: | |
| - 'docs/**' | |
| - 'README.md' | |
| - '*.md' | |
| jobs: | |
| validate: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Check for required documentation | |
| run: | | |
| if [ ! -f "README.md" ]; then | |
| echo "ERROR: README.md is missing" | |
| exit 1 | |
| fi | |
| if [ ! -d "docs" ]; then | |
| echo "ERROR: docs directory is missing" | |
| exit 1 | |
| fi | |
| echo "Documentation structure validated" | |
| - name: Validate markdown syntax | |
| run: | | |
| # Basic markdown validation (check for common issues) | |
| find "docs" -name "*.md" -type f | while read file; do | |
| if ! grep -q "^#" "$file"; then | |
| echo "WARNING: $file may be missing headers" | |
| fi | |
| done | |