[docs] Improve docs on updating API docs.#25366
Open
rolfbjarne wants to merge 1 commit intomainfrom
Open
Conversation
Contributor
There was a problem hiding this comment.
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.