PullProof
ActionsPullProof is a GitHub Action that reviews documentation changes in pull requests and provides feedback
v2.0.0
LatestTags
(2)
Proofreads every pull request like an editor. PullProof is a GitHub Action that automatically reviews blog posts and documentation changes in pull requests and provides AI-generated feedback.
| Dimension | What's Checked |
|---|---|
| Metadata & SEO | Title, description, date, author, tags — presence and quality |
| Technical Accuracy | Code examples, language tags, correctness of commands |
| Writing Quality | Grammar, spelling, clarity, tone consistency |
| Structure & Flow | Intro hook, logical progression, conclusion, heading hierarchy |
| Blog Polish | Cover image, references, length, visual aids |
- Detects changes in
.mdand.mdxfiles in a PR - Only reviews added lines (ignores deletions)
- Posts a structured review comment with ratings table and actionable feedback
- Updates the same comment on subsequent pushes (no comment spam)
- Configurable OpenAI model
Add this workflow to .github/workflows/pullproof.yml:
name: Documentation Review
on:
pull_request:
types: [opened, synchronize]
paths:
- "**.md"
- "**.mdx"
jobs:
review-docs:
runs-on: ubuntu-latest
permissions:
contents: read
pull-requests: write
steps:
- uses: actions/checkout@v4
- name: Run PullProof
uses: SyedSibtainRazvi/PullProof@v2.0.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
openai_api_key: ${{ secrets.OPENAI_API_KEY }}
# model: gpt-4o # optional, defaults to gpt-4o| Input | Required | Default | Description |
|---|---|---|---|
github_token |
Yes | — | GitHub token for PR access and commenting |
openai_api_key |
Yes | — | OpenAI API key for AI review |
model |
No | gpt-4o |
OpenAI model to use |
PullProof is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.