Add AI-powered documentation PR review agent (script and config) #1370
Conversation
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
Implements an automated documentation review system using Claude API that: - Reviews only changed lines in PRs (not pre-existing content) - Checks grammar, spelling, style guide adherence, MDX syntax, frontmatter, code blocks, and links - Posts inline comments on specific lines with severity levels - Provides actionable suggestions for fixes - Learns from accepted/ignored feedback over time - Follows Google Developer Documentation Style Guide - Excludes auto-generated reference documentation Components in this commit: - Python review agent script (.github/scripts/pr_review_agent.py) - Configuration file for customization (.github/pr-review-config.json) - Feedback tracking system for learning (.github/pr-review-feedback.json) - Comprehensive documentation (.github/PR_REVIEW_AGENT.md) Note: The GitHub Action workflow file (.github/workflows/pr-review.yml) needs to be added manually by a repository admin due to GitHub App permissions.
github-actions
bot
added
the
python
Contributor
|
Mintlify preview ID generated: preview-claude-1762810956-524603a |
lnhsingh
deleted the
claude/add-pr-review-agent-011CUzvG8i7XZQuKtyE2RGGi
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Implements an automated documentation review system using Claude API that:
Components in this commit:
Note: The GitHub Action workflow file (.github/workflows/pr-review.yml) needs to be added manually by a repository admin due to GitHub App permissions.
Overview
Type of change
Type: [Replace with: New documentation page / Update existing documentation / Fix typo/bug/link/formatting / Remove outdated content / Other]
Related issues/PRs
Checklist
docs devsrc/docs.jsonif neededAdditional notes