|
| 1 | +--- |
| 2 | +name: API Documentation Handoff from Prime to DevEx |
| 3 | +about: Formal handoff from the Prime team to DevEx for finalizing and publishing API documentation updates. |
| 4 | +title: "[Prime Documentation Handoff] <Short Description of Change>" |
| 5 | +labels: team/developer-experience, area/rest-api, status/needs-triage |
| 6 | +assignees: '' |
| 7 | + |
| 8 | +--- |
| 9 | + |
| 10 | +## Ticket & PR References |
| 11 | +- **Internal Ticket:** references [ticket] |
| 12 | +- **API PR:** references [open PR] |
| 13 | + |
| 14 | +--- |
| 15 | + |
| 16 | +## Background |
| 17 | + |
| 18 | +**Summary of Change:** |
| 19 | +Briefly explain what was added, changed, or removed in the API and why. |
| 20 | + |
| 21 | +**Deployment Timing:** |
| 22 | +When are the changes expected to go live? |
| 23 | + |
| 24 | +**Breaking Change:** |
| 25 | +Is this a breaking change? If so, what is the impact and how should it be communicated? |
| 26 | + |
| 27 | +--- |
| 28 | + |
| 29 | +## Handoff Checklist |
| 30 | + |
| 31 | +- [ ] API changes have been reviewed and approved by the Prime team. |
| 32 | +- [ ] TypeSpec/documentation builds successfully. |
| 33 | +- [ ] Preview looks correct and matches expectations. |
| 34 | + |
| 35 | +<details> |
| 36 | +<summary>Additional context (if any of the above items are unchecked)</summary> |
| 37 | + |
| 38 | +<!-- Add details here if there are known issues, blockers, or questions related to the docs. --> |
| 39 | + |
| 40 | +</details> |
| 41 | + |
| 42 | +--- |
| 43 | + |
| 44 | +## Next Steps |
| 45 | + |
| 46 | +- [ ] Prime will monitor this ticket for any follow-up questions or issues. |
| 47 | +- [ ] DevEx can proceed with documentation adjustments, merging, and publishing when ready. |
| 48 | + |
| 49 | +<!-- Add any relevant context or expectations around timing, testing, or coordination. |
| 50 | +If documentation should not be merged immediately — for example, if it depends on a specific deployment date or another task being completed first — please include those details here. --> |
| 51 | + |
| 52 | + |
| 53 | + |
0 commit comments