Skip to content

[Automated][azure-resource-manager] Add Agent base type how-to guide - #3

Draft
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/arm-agent-base-type-c85535550b922eef
Draft

[Automated][azure-resource-manager] Add Agent base type how-to guide#3
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/arm-agent-base-type-c85535550b922eef

Conversation

@github-actions

Copy link
Copy Markdown

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 with Agent, AgentConversation, and AgentResponse resource templates, Appliance/Platform deployment models, the @azureBaseType decorator, 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

  • New how-to guide website/src/content/docs/docs/howtos/ARM/agent-base-type.mdx:
    • Explains base types and the @azureBaseType decorator / BaseTypeInfo / BaseType enum.
    • Documents the Agent, AgentConversation, and AgentResponse templates and the child-resource / lifecycle requirements enforced by the two new lint rules.
    • Contrasts the Appliance (service-owned, read-only) and Platform (client-owned, writable) deployment models and the HasModelDeploymentRef / HasInstructions definition parameters.
    • Shows how to suppress the basetypes-experimental warning.
    • References the canonical resource-manager/resource-types/agent sample via <ExampleRef>.
    • Auto-appears in the Howtos sidebar (autogenerated from the howtos directory).
  • Knowledge base updated with notes on the base-types feature, the experimental suppression, and the fact that no per-rule website pages exist (link to reference/linter.md instead).
  • Metadata (azure-resource-manager.meta.json) updated to record the checkout commit for the next incremental run.

Verification

  • Built the ARM package and ran pnpm regen-docs — reference docs were already current (no diff).
  • Every template, model, decorator, mix-in, and rule referenced in the guide was verified against lib/base-types/*.tsp, lib/private.decorators.tsp, the two rule .md files, and the resource-types/agent sample.
  • cspell and prettier run clean on the changed files.

No publishable package source was modified (docs-only), so no changelog entry is required.

Generated by Documentation Update Agent · 267.8 AIC · ⌖ 18.5 AIC · ⊞ 8.1K ·

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants