[Automated][azure-resource-manager] Add Agent base type how-to guide - #3
Draft
github-actions[bot] wants to merge 1 commit into
Draft
[Automated][azure-resource-manager] Add Agent base type how-to guide#3github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.
Summary
Incremental documentation update for
@azure-tools/typespec-azure-resource-manager. The library recently added the experimental base types feature (Azure.ResourceManager.BaseTypes), including the Agent base type withAgent,AgentConversation, andAgentResponseresource templates, Appliance/Platform deployment models, the@azureBaseTypedecorator, and two new lint rules (arm-agent-base-type-child-resources,arm-agent-base-type-lifecycle-operations).The auto-generated reference docs (
reference/decorators.md,data-types.md,linter.md) already reflect these additions. This PR fills the remaining manual-documentation gap.Changes
website/src/content/docs/docs/howtos/ARM/agent-base-type.mdx:@azureBaseTypedecorator /BaseTypeInfo/BaseTypeenum.Agent,AgentConversation, andAgentResponsetemplates and the child-resource / lifecycle requirements enforced by the two new lint rules.HasModelDeploymentRef/HasInstructionsdefinition parameters.basetypes-experimentalwarning.resource-manager/resource-types/agentsample via<ExampleRef>.howtosdirectory).reference/linter.mdinstead).azure-resource-manager.meta.json) updated to record the checkout commit for the next incremental run.Verification
pnpm regen-docs— reference docs were already current (no diff).lib/base-types/*.tsp,lib/private.decorators.tsp, the two rule.mdfiles, and theresource-types/agentsample.cspellandprettierrun clean on the changed files.No publishable package source was modified (docs-only), so no changelog entry is required.