Skip to content

Docs: update links to new docs & futher iteration #7

Docs: update links to new docs & futher iteration

Docs: update links to new docs & futher iteration #7

Workflow file for this run

name: Verify Documentation
on:
pull_request:
paths:
- 'docs/code-reference/**'
jobs:
verify-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0 # Need full history to compare with base branch
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.4'
extensions: mbstring, xml
coverage: none
- name: Install dependencies
run: composer install --prefer-dist --no-progress
- name: Generate fresh documentation
run: |
# Create temp directory for fresh docs
mkdir -p temp/code-reference
# Generate fresh documentation
php docs/bin/generate-parsed-md.php --output=temp/code-reference
- name: Compare documentation
run: |
# Compare generated docs with existing docs
if ! diff -r --ignore-all-space --ignore-blank-lines docs/code-reference temp/code-reference; then
echo "::error::Documentation in docs/code-reference does not match what would be generated from source code."
echo "::error::Please update the source code documentation instead of modifying the generated files directly."
exit 1
fi