Skip to content

[docs] docs: fix inconsistencies in documentation folder #37982

@github-actions

Description

@github-actions

Summary

This PR fixes several inconsistencies found in the documentation/ folder by comparing the docs against the current source code and CONTRIBUTING.md.


Changes

1. pnpm build --filterpnpm turbo build --filter (6 files)

Files: linting.md, Quickstart-on-how-to-write-tests.md, steps-after-generations.md, RLC-Swagger-quickstart.md, writing-performance-tests.md

Issue: Multiple docs used pnpm build --filter=<pkg>... which does not correctly build a package and all its dependencies. CONTRIBUTING.md clearly states the correct command is pnpm turbo build --filter=<pkg>... (turbo's ... suffix resolves dependencies, while pnpm's filter ... suffix means "dependents", which is the opposite).

Fix: Changed all occurrences to pnpm turbo build --filter=....


2. npm install -g @pnpm`` → npm install -g pnpm (`Generate-code-from-TypeSpec.md`)

Issue: Line 52 referenced @pnpm (a scoped npm package that does not exist). The correct npm package name for the pnpm CLI is pnpm.

Fix: Corrected to npm install -g pnpm.


3. DefaultAzureCredential credential chain (using-azure-identity.md)

Issue: The DefaultAzureCredential section only listed 2 credential types it tries (EnvironmentCredential and ManagedIdentityCredential). The current implementation in sdk/identity/identity/src/credentials/defaultAzureCredential.ts tries 7 credential types.

Fix: Updated the list to match the current implementation:

  • EnvironmentCredential
  • WorkloadIdentityCredential
  • ManagedIdentityCredential
  • VisualStudioCodeCredential
  • AzureCliCredential
  • AzurePowerShellCredential
  • AzureDeveloperCliCredential

4. InteractiveBrowserCredential description (using-azure-identity.md)

Issue: Two outdated statements:

  1. The section described the credential as following the "implicit grant flow" — the current implementation uses the Authorization Code Flow (verified in interactiveBrowserCredential.ts line 40).
  2. A NOTE claimed "this credential can only be used in the browser but Node.js support will be added in the future (see issue Identity: Implement Interactive Authentication Support for Node.js applications #4774)". Node.js support has been available for several releases.

Fix: Updated the description to reference the Authorization Code Flow and removed the outdated browser-only NOTE, replacing it with accurate guidance for both Node.js and browser usage.

Generated by Documentation 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/documentation-consistency-fixes-be6986c7754ba1ed.

Click here to create the pull request

To fix the permissions issue, go to SettingsActionsGeneral and enable Allow GitHub Actions to create and approve pull requests. See also: gh-aw FAQ

Show patch preview (263 of 263 lines)
From 0c6fb1f607561f3217d484c01383b7ef56d277d4 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]" <github-actions[bot]@users.noreply.github.com>
Date: Mon, 6 Apr 2026 09:32:31 +0000
Subject: [PATCH] docs: fix inconsistencies in documentation folder
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

- Fix `pnpm build --filter` → `pnpm turbo build --filter` in multiple
  docs to match CONTRIBUTING.md guidance and ensure dependency builds
  are correctly resolved: linting.md, Quickstart-on-how-to-write-tests.md,
  steps-after-generations.md, RLC-Swagger-quickstart.md,
  writing-performance-tests.md

- Fix `npm install -g @pnpm` → `npm install -g pnpm` in
  Generate-code-from-TypeSpec.md (the @pnpm scoped name does not exist
  on npm)

- Update DefaultAzureCredential chain in using-azure-identity.md to
  list all 7 credential types it currently attempts (was listing only 2:
  EnvironmentCredential and ManagedIdentityCredential)

- Update InteractiveBrowserCredential section in using-azure-identity.md:
  - Replace outdated 'implicit grant flow' reference with the current
    'authorization code flow'
  - Remove outdated NOTE claiming the credential is browser-only;
    it has supported Node.js for several releases

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
---
 documentation/Generate-code-from-TypeSpec.md  |  2 +-
 .../Quickstart-on-how-to-write-tests.md       |  4 +--
 documentation/RLC-Swagger-quickstart.md       | 12 ++++-----
 documentation/linting.md                      |  2 +-
 documentation/steps-after-generations.md      | 12 ++++-----
 documentation/using-azure-identity.md         | 26 ++++++++++---------
 documentation/writing-performance-tests.md    |  2 +-
 7 files changed, 31 insertions(+), 29 deletions(-)

diff --git a/documentation/Generate-code-from-TypeSpec.md b/documentation/Generate-code-from-TypeSpec.md
index 73df7f4e3..990b5ceef 100644
--- a/documentation/Generate-code-from-TypeSpec
... (truncated)

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions