Skip to content

superplanehq/app_pr_docs_drift

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PR Docs Review

Launch in SuperPlane

A SuperPlane app that reviews every pull request for documentation impact using AI. When docs changes are needed, maintainers approve or reject via PR comments, and tracking issues are created automatically.

How it works

  1. PR opened or updated — AI agent analyzes the PR diff against your docs
  2. Docs impact detected — posts a PR comment with specific docs update suggestions
  3. Maintainer approves (/docs-agree) — creates a tracking issue on your docs repo
  4. Maintainer rejects (/docs-reject) — overrides the check, no issue created
  5. PR closed — closes any linked docs issue if the PR is closed without merging

The app includes a console dashboard tracking review stats, pending reviews, accepted/rejected outcomes.

Prerequisites

  • A SuperPlane account with a GitHub integration
  • A Claude integration with a configured agent
  • Two GitHub repositories: the source repo (PRs) and the docs repo (issues)

Install

Click Launch in SuperPlane at the top of this page. The wizard will ask you to select your source repository and docs repository.

After install:

  1. Connect a Claude integration and configure the agent on the Analyze Docs Impact node
  2. Customize docs_review_guidelines.md in the Files tab to match your project's docs structure
  3. Open a PR to test the review flow

Customizing the review

Edit docs_review_guidelines.md in the Files tab. This file tells the AI agent what to check, what to skip, and how to format its response. Tailor it to your project — add your docs site URL, list auto-generated files to skip, and define your verdict format.

License

MIT

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors