Add ARM library doc updater config and prompt#4281
Open
Conversation
tadelesh
requested review from
bterlson,
markcowl and
timotheeguerin
as code owners
Collaborator
|
No changes needing a change description found. |
Collaborator
|
You can try these changes here
|
Contributor
There was a problem hiding this comment.
Pull request overview
Adds doc-updater agent configuration and a dedicated prompt for the @azure-tools/typespec-azure-resource-manager library, so the agentic workflow can audit and update ARM documentation using ARM library source/templates and samples as primary references.
Changes:
- Added a doc-updater config for ARM defining source analysis paths and allowed modification scopes.
- Added an ARM-specific doc-updater prompt describing authoritative sources, doc areas, and a 3-step audit/fix workflow.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| eng/scripts/doc-updater/configs/azure-resource-manager.yaml | New ARM doc-updater config (source paths + allowedPaths) for the agentic workflow. |
| eng/scripts/doc-updater/prompts/azure-resource-manager.md | New ARM-specific agent prompt to guide documentation audits and updates. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
markcowl
requested changes
Apr 20, 2026
Member
markcowl
left a comment
markcowl
left a comment
There was a problem hiding this comment.
Marked some things that were incorrect in the local run of this. We should correct before deploying this.
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.
Add ARM library doc updater config and prompt
Adds the agentic workflow configuration and prompt for automated ARM library documentation updates.
Changes
eng/scripts/doc-updater/configs/azure-resource-manager.yaml— New config defining source code paths (lib, src, samples) and allowed modification paths for the doc updater agent.eng/scripts/doc-updater/prompts/azure-resource-manager.md— New prompt instructing the agent how to audit and fix ARM library documentation against authoritative sources.Key design decisions
.tsp/.tsover unit tests: ARM lib is primarily templates and decorators, so the TSP library declarations and TypeScript source are the primary references (not unit tests).packages/samples/specs/resource-manager/is referenced as an authoritative source for idiomatic ARM spec patterns.Testing
Tested on a private fork: