review-docs

name	review-docs
description	Step-by-step documentation gap detection for OpenAEV pull requests. Identifies functional code changes that are not reflected in docs/.

Review Docs

Step 1 — Identify all changed files in the PR

# Get all files changed in this PR compared to the base branch
gh pr diff --name-only

If gh pr diff is unavailable (e.g. not in a PR context), fall back to:

git fetch origin main
git diff --name-only $(git merge-base HEAD origin/main)

Separate the changed files into two categories:

• Functional files: anything in openaev-api/, openaev-model/, openaev-front/src/, openaev-framework/, configuration files
• Doc files: anything in docs/

If there are zero functional files changed (doc-only PR): output PASS and stop.

Step 2 — Filter out non-user-facing changes

Remove from the functional files list any files that match these patterns (they don't require doc updates):

# Test files
gh pr diff --name-only | grep -E "Test\.java$|\.test\.(ts|tsx)$|tests_e2e/"

# CI/Build files
gh pr diff --name-only | grep -E "\.github/workflows/|Dockerfile|docker-compose|pom\.xml$|package\.json$|yarn\.lock$"

# Code style / formatting
gh pr diff --name-only | grep -E 


gh  diff --name-only | grep -E 


gh  diff --name-only | grep -E