Skip to content

Bound comment-triggered docs reviews - #1316

Merged
danbarr merged 1 commit into
mainfrom
bound-comment-docs-reviews
Nov 4, 2026
Merged

danbarr merged 1 commit into
mainfrom
bound-comment-docs-reviews

Conversation

@danbarr

@danbarr danbarr commented Nov 4, 2026

Copy link
Copy Markdown
Collaborator

Description

Repeated comment-triggered reviews can keep proposing cosmetic changes, and reviewers without upstream source access can mistake agreement between documentation pages for technical verification. Make the Claude workflow explicitly load the review skills and apply their finding threshold.

The review instructions now distinguish direct verification from author-supplied evidence, scope follow-up reviews to fixes and affected content, and stop when no material findings remain. Cosmetic suggestions remain excluded even when labeled optional or nonblocking. These workflow instructions apply only to documentation review requests.

Type of change

  • Documentation update

Related issues/PRs

Validation

  • Production site build.
  • Prettier checks on all three changed files, workflow YAML and quoted argument parsing, and git diff --check.
  • zizmor --offline .github/workflows/claude.yml reports no findings.
  • Actionlint passes with its existing unsupported $/ local-action syntax diagnostic excluded; the unchanged workflow produces the same diagnostic.
  • No live Claude review run was triggered.

Submitter checklist

Content and formatting

  • I have reviewed the content for technical accuracy
  • I have reviewed the content for spelling, grammar, and style

Reviewer checklist

Content

  • I have reviewed the content for technical accuracy
  • I have reviewed the content for spelling, grammar, and style

Copilot AI balanced review requested due to automatic review settings November 4, 2026 18:22
@vercel

vercel Bot commented Nov 4, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
docs-website Ready Ready Preview Nov 4, 2026 6:25pm UTC

Request Review

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No active review issues are reported for the documentation-review workflow and skill changes.

No open issues 🎉

What changed in this PR

This PR bounds comment-triggered documentation reviews to reduce cosmetic churn and distinguish verified product behavior from author-supplied or unavailable evidence.

Changes:

  • Instructs the Claude workflow to load both review skills for documentation review requests.
  • Limits follow-up reviews to fixes and affected content, stopping when no material findings remain.
  • Explicitly excludes cosmetic suggestions, including those labeled optional or nonblocking.
File Description
.github/​workflows/​claude.yml Adds documentation-review-specific instructions to load and apply the review skills.
.claude/​skills/​review-docs-pr/​SKILL.md Clarifies evidence limits, follow-up scope, and stopping criteria.
.claude/​skills/​docs-review/​SKILL.md Requires concrete justification for findings and excludes cosmetic feedback.

Review effort: Balanced

@danbarr
danbarr merged commit 4d3558f into main Nov 4, 2026
8 checks passed
@danbarr
danbarr deleted the bound-comment-docs-reviews branch November 4, 2026 18:41

This branch was successfully deployed

1 active deployment
Preview — 701fab45 Deployed Nov 4, 2026 by vercel[bot]
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.

3 participants