You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Fix any failures before proceeding to the next phase. Do not defer fixes to end-of-session.
618
+
606
619
## State Tracking
607
620
608
621
Maintain a running progress tracker throughout the session. After each file or batch of files, update and display:
@@ -625,8 +638,9 @@ For Documentation Plans with many files (10+):
625
638
1.**Group by type:** resources, API methods, enumerations, permissions, supporting files
626
639
2.**Process in batches of 5 files** — complete all steps for each file before moving to the next
627
640
3.**After each batch**, output a phase status summary (see [Structured Output Format](#structured-output-format))
628
-
4.**Present the execution plan upfront** and proceed unless the author objects — avoid blocking confirmations for each batch when the Documentation Plan is clear
629
-
5.**If the plan exceeds 20 files**, create a numbered task list at the start, group into batches, and checkpoint progress after each batch
641
+
4.**Verify each batch before proceeding:** Re-read every file in the completed batch and confirm it contains the expected sections (e.g., H1, namespace, Permissions, HTTP request, Examples for API files; H1, namespace, Properties table, JSON representation for resource files). Fix any issues before starting the next batch.
642
+
5.**Present the execution plan upfront** and proceed unless the author objects — avoid blocking confirmations for each batch when the Documentation Plan is clear
643
+
6.**If the plan exceeds 20 files**, after the first batch completes and is verified, **stop and ask the author to confirm quality** before continuing. This catches systematic errors early.
630
644
631
645
## Decision Trees for Ambiguous Cases
632
646
@@ -702,6 +716,8 @@ Report any inconsistencies in the final summary to the author.
702
716
703
717
The following checks apply to every documentation scenario. Scenario-specific checklists add additional items on top of these.
704
718
719
+
> **IMPORTANT:** For each checklist item, re-read the actual file content to confirm — do not check items from memory.
720
+
705
721
**For all files (new and updated):**
706
722
-[ ] All required sections are present and in correct order
Copy file name to clipboardExpand all lines: .github/prompts/review-api-docs.prompt.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -297,6 +297,8 @@ Group files by type:
297
297
298
298
For each file, apply the appropriate review checklist from above.
299
299
300
+
**For PRs with 15+ changed files:** Review in batches of 10 files. After each batch, output findings so far before continuing to the next batch. This keeps context focused and prevents quality degradation on later files.
301
+
300
302
### Step 4: Run Validation Scripts
301
303
302
304
Run automated validation scripts to ensure compliance (see [Common Process: Validation](#common-process-validation)):
@@ -318,6 +320,8 @@ Use these criteria consistently when categorizing findings:
318
320
319
321
### Step 6: Report Findings
320
322
323
+
> **IMPORTANT:** Before finalizing the report, re-read each reviewed file to confirm your findings. Do not report issues or approvals from memory alone.
0 commit comments