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/author-api-docs/deprecate-retire.md
+17-8Lines changed: 17 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -214,10 +214,15 @@ Retirement is the final stage of the API lifecycle — the deprecated API has re
214
214
215
215
### Inputs for retirement
216
216
217
-
The Documentation Plan must explicitly identify:
218
-
- Which resources (entity types, complex types) are being retired (marked as "Deleted" or "Removed")
219
-
- Which API operation files are linked to the retired resources
220
-
-**Dependency analysis for related types:** Complex types referenced as property return types and entity types referenced as relationship targets must be explicitly called out. The Documentation Plan must state whether each related type is also being retired or should be retained.
217
+
Retirement can be triggered by:
218
+
-**Schema change:** A Documentation Plan or changelog showing `ChangeType: "Deletion"` for entities, complex types, properties, relationships, actions, or functions
219
+
-**Endpoint removal:** The product stops supporting an endpoint — this may not appear in the schema. The author will specify which endpoints are removed and the affected version(s).
220
+
221
+
The Documentation Plan or author prompt must identify:
222
+
- Which resources (entity types, complex types) are being retired
223
+
- Which version(s): beta, v1.0, or both
224
+
- The alternative API or resource (for redirects)
225
+
-**Dependency analysis for related types:** Complex types referenced as property return types and entity types referenced as relationship targets may still be in use by other APIs. Only delete a related type if it is explicitly called out as retired — otherwise retain it.
221
226
222
227
### Retirement workflow
223
228
@@ -242,11 +247,14 @@ Based on the Documentation Plan, delete:
242
247
3.**Permission include files** for the retired API operation files:
243
248
-`api-reference/{version}/includes/permissions/{operation}-permissions.md` (naming may vary — match the include reference in each API operation file)
244
249
245
-
4.**Complex type files** explicitly called out as retired/deleted in the Documentation Plan:
250
+
4.**RBAC include files** for the retired API operation files (if they exist and not in use by other APIs):
251
+
-`api-reference/{version}/includes/rbac-for-apis/{rbac-file}.md` (match the include reference in each API operation file)
252
+
253
+
5.**Complex type files** explicitly called out as retired/deleted in the Documentation Plan:
246
254
- Only delete if the Documentation Plan explicitly marks the complex type as retired/deleted
247
255
- If not explicitly called out as retired, retain the file
248
256
249
-
5.**Enum files or sections** explicitly called out as retired/deleted in the Documentation Plan:
257
+
6.**Enum files or sections** explicitly called out as retired/deleted in the Documentation Plan:
250
258
- For standalone enum files: delete if explicitly marked as retired
251
259
- For H3 sections in parent resources: removed when parent resource is deleted
252
260
- For entries in global enums files (`enums.md`, `enums-{subnamespace}.md`): remove the enum section
@@ -277,12 +285,12 @@ Add redirects for **resource files that include Methods tables** (entity types)
Copy file name to clipboardExpand all lines: .github/prompts/review-api-docs.prompt.md
+17Lines changed: 17 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -208,6 +208,18 @@ When reviewing resources that are part of a polymorphic hierarchy (base types wi
208
208
209
209
Full rules: [common.md — Cross-file consistency validation](./author-api-docs/common.md#cross-file-consistency-validation) (point d) and [public-preview.md — Handling polymorphic entity types](./author-api-docs/public-preview.md#handling-polymorphic-entity-types)
210
210
211
+
### Retirement (file deletion) review
212
+
213
+
When a PR deletes API documentation files, validate:
214
+
-**Completeness:** All API operation files, permission includes, and RBAC includes tied to a deleted entity type resource are also deleted
215
+
-**Retained types:** Complex types and entity types referenced by the deleted resource are NOT deleted unless explicitly called out — they may be in use by other APIs
216
+
-**Reference cleanup:** Deleted resources are removed from Methods tables, Relationships tables, and Properties tables in parent/related resource files
217
+
-**Redirects:** Each deleted entity type resource file and API operation file has a redirect entry in the latest `.openpublishing.redirection.yyyy-mm.json` file in `redirects/`
218
+
-**TOC:** Entries for deleted files removed from `toc.mapping.json`
219
+
-**Changelog and What's New:** Entries with Change type "Deletion" are present
220
+
221
+
Full rules: [deprecate-retire.md — Retirement workflow](./author-api-docs/deprecate-retire.md#retirement-api-removal) and [Retirement quality checklist](./author-api-docs/deprecate-retire.md#quality-checklist)
222
+
211
223
---
212
224
213
225
## Optional Context-Enhanced Review
@@ -285,6 +297,8 @@ Group files by type:
285
297
286
298
For each file, apply the appropriate review checklist from above.
287
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
+
288
302
### Step 4: Run Validation Scripts
289
303
290
304
Run automated validation scripts to ensure compliance (see [Common Process: Validation](#common-process-validation)):
@@ -306,6 +320,8 @@ Use these criteria consistently when categorizing findings:
306
320
307
321
### Step 6: Report Findings
308
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.
324
+
309
325
Provide a structured review report:
310
326
311
327
**Summary:**
@@ -341,6 +357,7 @@ If requested, provide specific edits to fix identified issues.
341
357
342
358
**Special handling:**
343
359
- Mixed scenarios: If both deprecation and other changes exist, flag this for the reviewer
360
+
- Retirement (file deletions): Validate redirect entries, reference cleanup, and dependency safety — see [Retirement review](#retirement-file-deletion-review)
344
361
- Autogenerated content: If file appears autogenerated (check metadata), validate that manual edits are appropriate
345
362
- Permission files: These are typically autogenerated; validate format but don't require extensive review unless issues are evident
0 commit comments