langchain-ai/docs
1
0
Fork 0
mirror of https://github.com/langchain-ai/docs.git synced 2026-08-26 18:26:37 -04:00
Code Issues 490 Packages Projects Releases Wiki Activity

[PR #1370] [CLOSED] Add AI-powered documentation PR review agent (script and config) #1506

New Issue
Closed
opened 2026-02-17 17:22:26 -05:00 by yindo · 0 comments
yindo commented 2026-02-17 17:22:26 -05:00
Owner
Copy Link
Copy Source

📋 Pull Request Information

Original PR: https://github.com/langchain-ai/docs/pull/1370
Author: @lnhsingh
Created: 11/10/2025
Status: ❌ Closed

Base: main ← Head: claude/add-pr-review-agent-011CUzvG8i7XZQuKtyE2RGGi

📝 Commits (1)

  • 758a12b Add AI-powered documentation PR review agent (script and config)

📊 Changes

4 files changed (+737 additions, -0 deletions)

View changed files

➕ .github/PR_REVIEW_AGENT.md (+284 -0)
➕ .github/pr-review-config.json (+27 -0)
➕ .github/pr-review-feedback.json (+28 -0)
➕ .github/scripts/pr_review_agent.py (+398 -0)

📄 Description

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.

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

  • GitHub issue:
  • Feature PR:
  • Linear issue:
  • Slack thread:

Checklist

  • I have read the contributing guidelines
  • I have tested my changes locally using docs dev
  • All code examples have been tested and work correctly
  • I have used root relative paths for internal links
  • I have updated navigation in src/docs.json if needed
  • I have gotten approval from the relevant reviewers
  • (Internal team members only / optional) I have created a preview deployment using the Create Preview Branch workflow

Additional notes

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/langchain-ai/docs/pull/1370 **Author:** [@lnhsingh](https://github.com/lnhsingh) **Created:** 11/10/2025 **Status:** ❌ Closed **Base:** `main` ← **Head:** `claude/add-pr-review-agent-011CUzvG8i7XZQuKtyE2RGGi` --- ### 📝 Commits (1) - [`758a12b`](https://github.com/langchain-ai/docs/commit/758a12bfd39eaf7c5ffb812a7dd48b133ee94d9f) Add AI-powered documentation PR review agent (script and config) ### 📊 Changes **4 files changed** (+737 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `.github/PR_REVIEW_AGENT.md` (+284 -0) ➕ `.github/pr-review-config.json` (+27 -0) ➕ `.github/pr-review-feedback.json` (+28 -0) ➕ `.github/scripts/pr_review_agent.py` (+398 -0) </details> ### 📄 Description 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. ## Overview <!-- Brief description of what documentation is being added/updated --> ## Type of change **Type:** [Replace with: New documentation page / Update existing documentation / Fix typo/bug/link/formatting / Remove outdated content / Other] ## Related issues/PRs <!-- Link to related issues, feature PRs, or discussions (if applicable) To automatically close an issue when this PR is merged, use closing keywords: - "closes #123" or "fixes #123" or "resolves #123" For regular references without auto-closing, just use: - "#123" or "See issue #123" Examples: - closes #456 (will auto-close issue #456 when PR is merged) - See #789 for context (will reference but not auto-close issue #789) --> - GitHub issue: - Feature PR: <!-- For LangChain employees, if applicable: --> - Linear issue: - Slack thread: ## Checklist <!-- Put an 'x' in all boxes that apply --> - [ ] I have read the [contributing guidelines](README.md) - [ ] I have tested my changes locally using `docs dev` - [ ] All code examples have been tested and work correctly - [ ] I have used **root relative** paths for internal links - [ ] I have updated navigation in `src/docs.json` if needed - I have gotten approval from the relevant reviewers - (Internal team members only / optional) I have created a preview deployment using the [Create Preview Branch workflow](https://github.com/langchain-ai/docs/actions/workflows/create-preview-branch.yml) ## Additional notes <!-- Any other information that would be helpful for reviewers --> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-02-17 17:22:26 -05:00
yindo closed this issue 2026-02-17 17:22:26 -05:00
yindo changed title from [PR #1370] Add AI-powered documentation PR review agent (script and config) to [PR #1370] [CLOSED] Add AI-powered documentation PR review agent (script and config) 2026-06-05 18:13:02 -04:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
deepagents
docs-infra
external
external
help wanted
integration
internal
internal
javascript
js/ts
langchain
langgraph
langsmith
needs-title
pull-request
Mirrored from GitHub Pull Request
 python
reference
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langchain-ai/docs#1506
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?