Skip to content

feat: add AI-powered Vague documentation review automation - #61

Open
mcclowes wants to merge 2 commits into
mainfrom
claude/ai-doc-review-automation-6Vl0S
Open

feat: add AI-powered Vague documentation review automation#61
mcclowes wants to merge 2 commits into
mainfrom
claude/ai-doc-review-automation-6Vl0S

Conversation

@mcclowes

Copy link
Copy Markdown
Owner

Add a new module that uses Anthropic AI APIs to periodically review
Vague documentation and identify changes needed in Reqon.

Components:

  • Anthropic API client with retry/backoff logic
  • GitHub API integration to fetch Vague docs and source
  • Documentation analyzer comparing Vague with Reqon implementation
  • Reporter with console, JSON, and markdown output formats
  • CLI command (reqon-ai-review) for manual execution
  • GitHub Actions workflow for weekly automated reviews

Usage:
ANTHROPIC_API_KEY=sk-... npm run ai-review
ANTHROPIC_API_KEY=sk-... npm run ai-review:save --verbose

The workflow runs weekly and creates GitHub issues when changes
are detected in Vague that may require Reqon updates.

@vercel

vercel Bot commented Dec 22, 2025

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
reqon Ready Ready Preview, Comment Jan 8, 2026 11:50pm

claude added 2 commits January 8, 2026 23:48
Add a new module that uses Anthropic AI APIs to periodically review
Vague documentation and identify changes needed in Reqon.

Components:
- Anthropic API client with retry/backoff logic
- GitHub API integration to fetch Vague docs and source
- Documentation analyzer comparing Vague with Reqon implementation
- Reporter with console, JSON, and markdown output formats
- CLI command (reqon-ai-review) for manual execution
- GitHub Actions workflow for weekly automated reviews

Usage:
  ANTHROPIC_API_KEY=sk-... npm run ai-review
  ANTHROPIC_API_KEY=sk-... npm run ai-review:save --verbose

The workflow runs weekly and creates GitHub issues when changes
are detected in Vague that may require Reqon updates.
Add change detection to avoid running expensive AI analysis when
Vague repository hasn't changed since the last review.

Changes:
- Add ReviewStateStore to track last reviewed commit SHA
- Add checkForChanges() method to DocumentationAnalyzer
- Add --check-only flag (no API key needed) to check for changes
- Add --force flag to bypass change detection
- Update GitHub Actions workflow to check changes first
- Skip review job entirely if no changes (saves API costs)

Exit codes:
- 0: No changes needed
- 1: Changes needed (non-critical)
- 2: Critical changes needed
- 3: Skipped (no changes since last review)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants