[docs] Fix documentation inconsistencies in golden-testing-commands and reviewer-agents
documentationautomatedagentic-workflows
## Summary
Reviewed all markdown files under `documentation/` and found two files with verifiable inconsistencies against the actual repository structure and tooling.
---
### `documentation/golden-testing-commands.md`
**Problem: `npm run` used instead of `pnpm run`**
All terminal-level test commands used `npm run ...` but this repository exclusively uses `pnpm`. Examples:
| Before | After |
|--------|-------|
| `npm run test:browser` | `pnpm run test:browser` |
| `npm run test:node` | `pnpm run test:node` |
| `npm run unit-test:node` | `pnpm run unit-test:node` |
| `npm run integration-test:node` | `pnpm run integration-test:node` |
**Problem: Non-standard build command**
The table showed `pnpm -F {./}... build`, which uses pnpm's native workspace filter — not turbo. This contradicts both `CONTRIBUTING.md` and `AGENTS.md`, which specify using turbo for builds. Replaced with:
- `npx turbo build` — run from inside the package directory
- `pnpm turbo build --filter=<package-name>...` — run from anywhere in the repo
---
### `documentation/reviewer-agents.md`
**Problem: `mgmt-breaking-change-analysis` agent missing throughout**
The agent file `.github/agents/mgmt-breaking-change-analysis.agent.md` exists in the repository and is listed in `AGENTS.md`, but was completely absent from the reviewer-agents documentation. Added it to:
1. The **Available Agents** table (with a note that it is on-demand only, with no CI label trigger)
2. The **Invoking an Agent** example section
3. The **Available Agent Names** table for VS Code
4. The **`.github/` directory tree** under "Agent Configuration"
Also added to the directory tree:
- `.github/agents/mgmt-breaking-change-analysis.agent.md`
- `.github/prompts/mgmt-breaking-change-analysis-guidelines.md`
- `.github/workflows/mgmt-guidance.md` / `mgmt-guidance.lock.yml` (existed on disk but was missing from the listing)
> Generated by [Documentation Consistency Check](https://github.com/Azure/azure-sdk-for-js/actions/runs/28366403232) · 190.2 AIC · ⌖ 14.9 AIC · ⊞ 5.5K · [◷](https://github.com/search?q=repo%3AAzure%2Fazure-sdk-for-js+%22gh-aw-workflow-id%3A+docs-consistency-check%22&type=pullrequests)
<!-- gh-aw-agentic-workflow: Documentation Consistency Check, engine: copilot, version: 1.0.63, model: claude-sonnet-4.6, id: 28366403232, workflow_id: docs-consistency-check, run: https://github.com/Azure/azure-sdk-for-js/actions/runs/28366403232 -->
<!-- gh-aw-workflow-id: docs-consistency-check -->
<!-- gh-aw-workflow-call-id: Azure/azure-sdk-for-js/docs-consistency-check -->
---
> [!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/fix-documentation-inconsistencies-1a39e6e6dbd4550f`.
>
> **[Click here to create the pull request](https://github.com/Azure/azure-sdk-for-js/compare/main...docs/fix-documentation-inconsistencies-1a39e6e6dbd4550f?expand=1&title=%5Bdocs%5D%20Fix%20documentation%20inconsistencies%20in%20golden-testing-commands%20and%20reviewer-agents)**
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)
<details><summary>Show patch preview (152 of 152 lines)</summary>
```diff
From 86d26b91d7c8daeee3e0798959e0d0d76babd8c4 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]" <github-actions[bot]@users.noreply.github.com>
Date: Mon, 29 Jun 2026 10:52:54 +0000
Subject: [PATCH] docs: fix inconsistencies in golden-testing-commands and
reviewer-agents
- golden-testing-commands.md: Replace `npm run` with `pnpm run` for all
terminal commands (the repo uses pnpm, not npm). Also replace the
non-standard `pnpm -F {./}... build` filter syntax with the
canonical `npx turbo build` (in-package) and
`pnpm turbo build --filter=<package-name>...` (repo-wide) commands
that match CONTRIBUTING.md and AGENTS.md guidance.
- reviewer-agents.md: Add the `mgmt-breaking-change-analysis` agent
that exists in `.github/agents/` but was missing from the agents
table, the VS Code Available Agent Names table, the example
invocations section, and the `.github/` directory tree. Also add
the missing `mgmt-guidance.md / mgmt-guidance.lock.yml` workflow
files and the `mgmt-breaking-change-analysis-guidelines.md` prompt
file to the directory tree.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
---
documentation/golden-testing-commands.md | 29 ++++++++++++------------
documentation/reviewer-agents.md | 9 ++++++++
2 files changed, 24 insertions(+), 14 deletions(-)
diff --git a/documentation/golden-testing-commands.md b/documentation/golden-testing-commands.md
index f746dfdc2..bb501b076 100644
--- a/documentation/golden-testing-commands.md
+++ b/documentation/golden-testing-commands.md
@@ -6,19 +6,20 @@ If you're looking to be onboarded to the asset-sync workflow to push out the tes
## `pnpm` Commands
-| script name | What does it do? |
-|:------------------------|:----------------------------------------------------------------------------------------------------------------|
-| `pnpm install` | Upda
... (truncated)
```
</details>
0 条评论