Azure / Azure/typespec-azure

[Automated][azure-resource-manager][skip chg] Update ARM documentation for new lint rules

Open
#5,472 0 comments 0 reactions 0 assignees View on GitHub
agentic-workflows docs lib:azure-resource-manager
Dominant language
TypeScript
Stars
27
Forks
90
Avg merge
1d 22h
Merged PRs (30d)
156

Description

## Summary

- document eight new Azure Resource Manager lint rules across the rules, operations, LRO, resource type, RPC coverage, and versioning guides
- correct ARM resource examples and doc comments to match current library templates and canonical samples
- regenerate ARM reference documentation and record durable guidance for future documentation updates

## Validation

- `pnpm format`
- `pnpm lint`
- ARM package dependency build
- updated TypeSpec example compilation
- `pnpm regen-docs`
- Prettier and CSpell checks

No changelog was added because these are documentation-only changes.

> Generated by [Documentation Update Agent](https://github.com/Azure/typespec-azure/actions/runs/34826696085) · gpt56 · 1.1K AIC · ⌖ 45.6 AIC · ⊞ 19.1K · [◷](https://github.com/search?q=repo%3AAzure%2Ftypespec-azure+%22gh-aw-workflow-id%3A+doc-update%22&type=pullrequests)

---

> [!NOTE]
> This was originally intended as a pull request, but GitHub Actions is not permitted to create or approve pull requests in this repository.
> The changes have been pushed to branch `docs/arm-incremental-20260914-6ce9670280421d1c`.
>
> **[Click here to create the pull request](https://github.com/Azure/typespec-azure/compare/main...docs/arm-incremental-20260914-6ce9670280421d1c?expand=1&title=%5BAutomated%5D%5Bazure-resource-manager%5D%5Bskip%20chg%5D%20Update%20ARM%20documentation%20for%20new%20lint%20rules)**

To fix the permissions issue, go to **Settings** → **Actions** → **General** and enable **Allow GitHub Actions to create and approve pull requests**. See also: [gh-aw FAQ](https://github.github.com/gh-aw/reference/faq/#why-is-my-create-pull-request-workflow-failing-with-github-actions-is-not-permitted-to-create-or-approve-pull-requests)

Show patch preview (500 of 573 lines)

```diff
From 93ee910861c232cf6193d71fcb5bd6f423210203 Mon Sep 17 00:00:00 2001
X-GH-AW-Base-Commit: 5f4088cb98034d388da0ca32db6c2172103c3abe
From: "github-actions[bot]"
Date: Mon, 14 Sep 2026 09:48:01 +0000
Subject: [PATCH] Update ARM documentation for lint rules

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
---
.../knowledge/azure-resource-manager.md | 36 ++++++++++++++-
.../azure-resource-manager.meta.json | 4 +-
.../lib/legacy-types/resource.tsp | 2 +-
.../lib/models.tsp | 9 +---
.../content/docs/docs/howtos/ARM/arm-rules.md | 10 ++++-
.../howtos/ARM/long-running-operations.md | 5 ++-
.../docs/howtos/ARM/resource-operations.md | 45 ++++++++++++-------
.../docs/docs/howtos/ARM/resource-type.mdx | 28 +++++++-----
.../howtos/ARM/rpc-guidelines-coverage.md | 39 ++++++++++++----
.../docs/docs/howtos/ARM/versioning.md | 9 ++--
.../reference/data-types.md | 11 ++---
11 files changed, 139 insertions(+), 59 deletions(-)

diff --git a/eng/scripts/doc-updater/knowledge/azure-resource-manager.md b/eng/scripts/doc-updater/knowledge/azure-resource-manager.md
index 601aef43d..8e701c6c4 100644
--- a/eng/scripts/doc-updater/knowledge/azure-resource-manager.md
+++ b/eng/scripts/doc-updater/knowledge/azure-resource-manager.md
@@ -38,7 +38,11 @@ model Employee is TrackedResource {

Rule documentation is authored beside each rule in `packages/typespec-azure-resource-manager/src/rules/*.md` and associated with the rule through its `docs` field. `pnpm regen-docs` passes `--rules-dir ../rules` and generates the website rule pages under `website/src/content/docs/docs/libraries/azure-resource-manager/rules/`. That website directory is ignored by Git and must not be edited manually.

-The `use-relationship-required-properties`, `use-api-version`, `use-operation-decorator`, and `use-interface` rule
... (truncated)
```

Contributor guide

Open the contributing guide

Research direction

Review the ARM documentation files under content/docs/docs/howtos/ARM, the rule knowledge file, and the listed TypeSpec sources and reference data. Run pnpm format, pnpm lint, the ARM package dependency build, updated TypeSpec example compilation, and pnpm regen-docs. Done means the eight lint rules and corrected examples are documented, generated references are current, and all listed checks pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.