Skip to content
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions .github/workflows/docs-quality.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Documentation Quality Check

on:
push:
branches: [ main, develop ]
pull_request:
branches: [ main ]

jobs:
docs-quality:
runs-on: ubuntu-latest
name: Check Documentation Quality

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Analyze documentation files
run: |
echo "πŸ” Starting documentation quality analysis..."

# Count documentation files
doc_files=$(find . -name "*.md" | wc -l)
echo "πŸ“„ Total markdown files: $doc_files"

# Count code blocks in documentation
code_blocks=$(grep -r '```' docs/ | wc -l)
echo "πŸ’» Code examples: $code_blocks" >> $GITHUB_STEP_SUMMARY

# Check for broken internal links
broken_links=$(grep -r "\[.*\](\./" . | grep -v ".git" | wc -l)
echo "πŸ”— Internal links found: $broken_links"

# Analyze API documentation
if [ -f "API_DOCUMENTATION.md" ]; then
api_endpoints=$(grep -c "### " API_DOCUMENTATION.md)
echo "πŸ”§ API endpoints documented: $api_endpoints"
fi

# Generate summary
echo "## πŸ“Š Documentation Quality Report" >> $GITHUB_STEP_SUMMARY
echo "- πŸ“„ Markdown files: $doc_files" >> $GITHUB_STEP_SUMMARY
echo "- πŸ’» Code examples: $code_blocks" >> $GITHUB_STEP_SUMMARY
echo "- πŸ”— Internal links: $broken_links" >> $GITHUB_STEP_SUMMARY