Add docs-review skill for PR suggestions#28414
Conversation
Teaches the agent when and how to post GitHub PR suggestions using the REST API instead of making direct edits. Includes single-line, multi-line, and batched review examples. Content rules reference covers MDX, frontmatter, links, style guide, code examples, and accuracy checks.
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
- Rewrite decision logic: fix obvious errors by default (MDX syntax, broken code, invalid frontmatter), only suggest when explicitly asked or when the invoker differs from the PR author - Remove duplicated code correctness checks (error handling, any types, hardcoded secrets) from content-rules.md — defer to code-review skill - Add cross-references to code-review skill for type checking, API usage, and binding patterns - Slim down Content Accuracy table to reference shared sources instead of inlining paths already documented in code-review
|
Here's a summary of the changes: 1. Fixed suggest-vs-edit bias (
|
|
Preview URL: https://6337108c.preview.developers.cloudflare.com |
ctdsf
left a comment
There was a problem hiding this comment.
Thanks for the help i dont know wtf im doing but thanks
Done. Here's a summary of what was created:
New skill:
.agents/skills/docs-review/Files created
SKILL.md(192 lines) — Main skill definitionreferences/content-rules.md(78 lines) — Detailed review checklistWhat the skill covers
When to suggest vs. edit — Decision table mapping instructions like "review", "suggest changes", "only make suggestions", "fix", "address this" to the correct action (post suggestions vs. edit files). Defaults to suggestions unless explicitly told to edit.
ghCLI suggestion API — Concrete, copy-paste examples for:-F line=N)-F start_line=N -F line=M)--input -and JSON body for 3+ comments)Key rules derived from PR research:
-F(not-f) for numeric fieldsside="RIGHT"andsubject_type="line"Content review principles — Distilled from ~30 PRs with @elithrar and @irvinebroque feedback:
TypeScriptExample,WranglerConfig,PackageManagers(from Fix Images docs code examples (7 files) #28396, Add docs for wrangler dev + tunnels #28228, Merge R2 upload & multipart docs #28186 — elithrar)Envtypes)Closes #28413
github run