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/author-api-docs.prompt.md
+35-4Lines changed: 35 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -77,6 +77,7 @@ Before beginning any documentation process, instruct the author to add all requi
77
77
- Files should be deleted from temp-docstubs after documentation is complete
78
78
- Always reference the temp-docstubs folder when asking for or reading input files
79
79
- Never ask the author to provide absolute file paths outside the workspace
80
+
-**Automated validation:** A validation script prevents temporary files from being accidentally committed (see [Common Process: Validation](#common-process-validation))
80
81
81
82
### Common Process: Updating the Changelog
82
83
@@ -211,10 +212,7 @@ Use the JSON template and examples from **templates/changelog-patterns.md**.
211
212
212
213
**Step 7: Validate the entry**
213
214
214
-
Follow the complete validation checklist in **templates/changelog-patterns.md** and run:
215
-
```powershell
216
-
.\validate-changelog-json.ps1
217
-
```
215
+
Follow the complete validation checklist in **templates/changelog-patterns.md** and see [Common Process: Validation](#common-process-validation) for running the validation script.
**When promoting from beta to v1.0:** Remove SDK snippets and tab markers for files copied from beta; keep only HTTP examples (see [Scenario 2](#scenario-2-promote-apis-from-beta-to-v10)).
305
303
304
+
### Common Process: Validation
305
+
306
+
After making documentation changes, run these validation scripts to ensure compliance:
307
+
308
+
**Validate changelog JSON files:**
309
+
```powershell
310
+
.\scripts\validate-changelog-json.ps1
311
+
```
312
+
- Validates all changelog files in the `changelog/` folder
313
+
- Checks schema compliance, required properties, and formatting
314
+
- Must pass before committing changelog updates
315
+
316
+
**Validate temp-docstubs cleanup:**
317
+
```powershell
318
+
.\scripts\validate-temp-docstubs.ps1
319
+
```
320
+
- Verifies that only `temp-docstubs-instructions.md` remains in temp-docstubs folder
321
+
- Prevents accidental commit of temporary input files
322
+
- Run after completing Doc Stubs Cleanup
323
+
324
+
**When validation fails:**
325
+
- Review error messages to identify issues
326
+
- Correct the problems in the affected files
327
+
- Re-run validation until all checks pass
328
+
306
329
---
307
330
308
331
### Reference Standards: Namespace Qualification
@@ -719,6 +742,7 @@ Remove "(preview)" from TOC entries as applicable:
719
742
-[ ] All TOC entries updated
720
743
-[ ] Changelog and What's new updated
721
744
-[ ] No markdown lint errors remain
745
+
-[ ] Validation completed (see [Common Process: Validation](#common-process-validation))
722
746
-[ ] Provided summary of all files created/modified to author
723
747
724
748
---
@@ -960,6 +984,7 @@ When combining deprecation with new APIs/promotions:
960
984
**Final:**
961
985
-[ ] All Summary items addressed
962
986
-[ ] No markdown lint errors
987
+
-[ ] Validation completed (see [Common Process: Validation](#common-process-validation))
963
988
-[ ] Summary provided to author
964
989
965
990
---
@@ -1809,6 +1834,7 @@ Before completing any authoring task, verify:
1809
1834
- [ ] All TOC changes made if applicable
1810
1835
- [ ] All properties referencing updated enumerations have been updated
1811
1836
- [ ] All permissions files copied
1837
+
- [ ] Validation completed (see [Common Process: Validation](#common-process-validation))
1812
1838
- [ ] Provided summary of all files created/modified to author
1813
1839
1814
1840
---
@@ -1928,6 +1954,7 @@ Before completing Scenario 4 tasks, verify:
1928
1954
- [ ] Examples use pseudo-values, not data types
1929
1955
- [ ] No markdown lint errors
1930
1956
- [ ] Changelog, What's new, and TOC mapping updated only if appropriate
1957
+
- [ ] Validation completed (see [Common Process: Validation](#common-process-validation))
1931
1958
- [ ] Summary of changes provided to author
1932
1959
1933
1960
---
@@ -1947,6 +1974,10 @@ After completing the documentation work and providing the final summary to the a
1947
1974
- If the author confirms, delete all files from `temp-docstubs` folder except `temp-docstubs-instructions.md`
1948
1975
- Confirm deletion: "Cleanup complete. All temporary files have been removed from the temp-docstubs folder."
1949
1976
1977
+
4. **Validate cleanup:**
1978
+
- See [Common Process: Validation](#common-process-validation) for validation instructions
1979
+
- If validation passes, confirm: "Validation passed: temp-docstubs folder is ready for commit."
1980
+
1950
1981
**Note:** The `temp-docstubs-instructions.md` file should never be deleted as it provides important guidance for future authoring sessions.
1951
1982
1952
1983
If you cannot resolve all issues or confirm information against API.md, notify the author to manually address remaining problems.
Copy file name to clipboardExpand all lines: .github/prompts/review-api-docs.prompt.md
+84-9Lines changed: 84 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -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