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
Copy file name to clipboardExpand all lines: .github/prompts/review-api-docs.prompt.md
+86-11Lines changed: 86 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,7 +37,7 @@ Ask the reviewer which documentation changes need to be reviewed:
37
37
While not required, providing these files significantly improves review quality and completeness:
38
38
39
39
**Optional Context Files (provide if available):**
40
-
-**Summary of API changes in documentation-plan.md:** A description of what documentation changes were expected based on the schema changes (identifies files changed, methods documented, resources added/updated, namespace information)
40
+
-**Documentation Plan in documentation-plan.md:** A description of what documentation changes were expected based on the schema changes (identifies files changed, methods documented, resources added/updated, namespace information)
41
41
-**API.md file:** The API specification file describing capabilities in detail
42
42
43
43
**Why these files help:**
@@ -49,6 +49,62 @@ While not required, providing these files significantly improves review quality
49
49
50
50
---
51
51
52
+
## Common Process: Validation
53
+
54
+
As part of the review process, validate that automated validation scripts pass. These scripts ensure compliance with required standards and prevent common errors.
55
+
56
+
### Validate changelog JSON files
57
+
58
+
After reviewing changelog changes, run the changelog validation script:
59
+
60
+
```powershell
61
+
.\scripts\validate-changelog-json.ps1
62
+
```
63
+
64
+
**Purpose:**
65
+
- Validates all changelog files in the `changelog/` folder against the schema
66
+
- Checks schema compliance, required properties, and formatting
67
+
- Ensures proper JSON structure and required metadata
**Must pass before:** Approving PR that touched temp-docstubs folder
92
+
93
+
### When validation fails
94
+
95
+
**If validation scripts report errors:**
96
+
1. Review error messages to identify specific issues
97
+
2. Flag the issues in your review report under "Critical Issues (Must Fix)"
98
+
3. Provide guidance on correcting the problems
99
+
4. Request author to re-run validation after fixes
100
+
5. Do not approve until all validation checks pass
101
+
102
+
**Common validation failures:**
103
+
- Changelog: Missing required properties, incorrect date format, malformed JSON
104
+
- temp-docstubs: Temporary files not removed before commit
105
+
106
+
---
107
+
52
108
## Review Guidelines
53
109
54
110
The review process applies guidelines from three authoritative sources. You should check all sets of guidelines without duplication:
@@ -145,22 +201,24 @@ For files in `api-reference/v1.0/resources/` and `api-reference/beta/resources/`
145
201
146
202
### Changelog Files Review
147
203
148
-
For files in `changelog/`, verify structure matches [templates/changelog-patterns.md](templates/changelog-patterns.md).
204
+
For files in `changelog/`, verify structure matches [templates/changelog-patterns.md](templates/changelog-patterns.md) and run validation (see [Common Process: Validation](#common-process-validation)).
@@ -345,6 +416,8 @@ If requested, provide specific edits to fix identified issues.
345
416
- Current: "Added property"
346
417
- Suggestion: "Added the **newProperty** property to enable..."
347
418
419
+
### API overview updates
420
+
- If an API Overview topic covers the same APIs, consider updating it to reflect new capabilities and changes for better discoverability and context for users.
348
421
---
349
422
350
423
## Files Approved
@@ -362,11 +435,13 @@ If requested, provide specific edits to fix identified issues.
362
435
363
436
1.**Start with file classification** - Understanding file types helps apply the right rules
364
437
2.**Check metadata first** - Validate namespace, doc_type, and version before content review
365
-
3.**Use find/search** - Look for TODO placeholders across all files
366
-
4.**Validate links** - Ensure all referenced resources and types exist and are correctly linked
367
-
5.**Check consistency** - Resource names, namespaces, and terminology should be consistent across all files
368
-
6.**Compare with context** - If Summary of API changes (documentation-plan.md file) or API.md provided, validate against them first
369
-
7.**Flag autogeneration issues** - If doc stubs appear to have over-generated content, mention this
438
+
3.**Run validation scripts early** - Check changelog and temp-docstubs validation before detailed review
439
+
4.**Use find/search** - Look for TODO placeholders across all files
440
+
5.**Validate links** - Ensure all referenced resources and types exist and are correctly linked
441
+
6.**Check consistency** - Resource names, namespaces, and terminology should be consistent across all files
442
+
7.**Compare with context** - If Summary of API changes (documentation-plan.md file) or API.md provided, validate against them first
443
+
8.**Flag autogeneration issues** - If doc stubs appear to have over-generated content, mention this
444
+
9.**Include validation results** - Always report validation script results in your review summary
0 commit comments