Skip to content

[docs] Improve docs on updating API docs.#25366

Open
rolfbjarne wants to merge 1 commit intomainfrom
dev/rolf/docs-sample-ticket
Open

[docs] Improve docs on updating API docs.#25366
rolfbjarne wants to merge 1 commit intomainfrom
dev/rolf/docs-sample-ticket

Conversation

@rolfbjarne
Copy link
Copy Markdown
Member

No description provided.

Copilot AI review requested due to automatic review settings May 7, 2026 19:58
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR improves the release/documentation workflow guidance for updating API reference docs by adding concrete links/placeholders for follow-up artifacts (PRs/tickets), making the process easier to track end-to-end during a release.

Changes:

  • Add an example Azure DevOps ticket link for the “flip monikers from prerelease to live” step.
  • Expand the release checklist with sub-items to capture required PR/ticket links for API diff, docs sync, and API/reference docs updates.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
docs/update-api-docs.md Adds a sample ticket link for the moniker flip step to make the final stage of the process more actionable.
docs/ReleaseCheckList.md Adds nested checklist items prompting links to the relevant PRs/tickets for API diff, docs sync, and API/reference docs steps.

@rolfbjarne rolfbjarne enabled auto-merge (squash) May 7, 2026 21:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants