Skip to content

[TCGC] Action to auto update TCGC doc#3888

Open
tadelesh wants to merge 30 commits intomainfrom
update-tcgc-doc-workflow
Open

[TCGC] Action to auto update TCGC doc#3888
tadelesh wants to merge 30 commits intomainfrom
update-tcgc-doc-workflow

Conversation

@tadelesh
Copy link
Member

@tadelesh tadelesh commented Feb 4, 2026

Resolve: #3868

@azure-sdk
Copy link
Collaborator

azure-sdk commented Feb 4, 2026

All changed packages have been documented.

  • @azure-tools/azure-http-specs
Show changes

@azure-tools/azure-http-specs - feature ✏️

Add Spector specs for @responseAsBool and @clientDoc decorators.

@azure-sdk
Copy link
Collaborator

azure-sdk commented Feb 4, 2026

You can try these changes here

🛝 Playground 🌐 Website

@microsoft-github-policy-service microsoft-github-policy-service bot added the lib:tcgc Issues for @azure-tools/typespec-client-generator-core library label Feb 10, 2026
@pkg-pr-new
Copy link

pkg-pr-new bot commented Feb 10, 2026

Open in StackBlitz

npm i https://pkg.pr.new/Azure/typespec-azure/@azure-tools/azure-http-specs@3888
npm i https://pkg.pr.new/Azure/typespec-azure/@azure-tools/typespec-client-generator-core@3888

commit: 04bda47

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds an automated “doc update agent” workflow and refreshes/expands TCGC documentation + Spector coverage to keep docs/specs aligned with current TCGC behavior.

Changes:

  • Update TCGC emitter/dev and design docs to reflect newer APIs (@clientLocation, children, clientInitialization, etc.).
  • Add new Spector specs + mock APIs for @clientDoc and @responseAsBool, and regenerate the scenario summary.
  • Introduce a scheduled GitHub Actions workflow plus a custom agent definition to periodically trigger doc maintenance tasks.

Reviewed changes

Copilot reviewed 16 out of 16 changed files in this pull request and generated 7 comments.

Show a summary per file
File Description
website/src/content/docs/docs/libraries/typespec-client-generator-core/guideline.md Updates guidance to use @clientLocation and documents @apiVersion / @clientApiVersions.
packages/typespec-client-generator-core/design-docs/client.md Refreshes terminology for client hierarchy/initialization in the design doc.
packages/azure-http-specs/specs/azure/client-generator-core/response-as-bool/mockapi.ts Adds mock API for the @responseAsBool scenario.
packages/azure-http-specs/specs/azure/client-generator-core/response-as-bool/main.tsp Adds Spector scenario for @responseAsBool.
packages/azure-http-specs/specs/azure/client-generator-core/client-doc/mockapi.ts Adds mock APIs for @clientDoc scenarios.
packages/azure-http-specs/specs/azure/client-generator-core/client-doc/main.tsp Adds Spector scenarios covering @clientDoc replace/append modes.
packages/azure-http-specs/spec-summary.md Regenerated scenarios summary to include new scenarios and updated scenario metadata.
cspell.yaml Adds domain words used by new scenarios/namespaces.
.github/workflows/tcgc-doc-update-scheduler.yml Adds weekly scheduler workflow to trigger the doc-update agent task.
.github/agents/tcgc-doc-updater.agent.md Defines the agent scope/guardrails and update procedure.
.chronus/changes/update-tcgc-docs-and-specs-2026-2-5-0-0-0.md Changelog entry for the new Spector specs.

tadelesh and others added 4 commits February 10, 2026 14:07
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…ient-doc/main.tsp

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…ient-doc/main.tsp

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

```java
// When @markAsLro is applied, the operation returns a poller
public SyncPoller<PollOperationDetails, DeploymentResult> beginStartDeployment(
Copy link
Member

@weidongxu-microsoft weidongxu-microsoft Feb 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you know whether/how Java (actually -- TCGC) knows poll response as PollOperationDetails, given the decorator is only @markAsLro?

Comment on lines +724 to +728
// When the service returns "", the value will be deserialized as null
public final class MyModel {
public String getDisplayName() { ... }
public String getDescription() { ... }
}
Copy link
Member

@weidongxu-microsoft weidongxu-microsoft Feb 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Java does not support this @deserializeEmptyStringAsNull.

@weidongxu-microsoft
Copy link
Member

weidongxu-microsoft commented Feb 10, 2026

Interesting idea. We can use similar solution for simple maintenances tasks like doc and version bump etc.

In the execution of the doc pages, I'd hope we could have a validation step, to compare the doc filled by agent, with yaml/code generated from emitter (from the source tsp in doc). So that we can avoid hallucination from LLM pollute downstream consumers (particularly, if one emitter does not support a feature, we'd avoid document saying that it supports).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

eng lib:tcgc Issues for @azure-tools/typespec-client-generator-core library

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[TCGC] Doc auto-update agent

5 participants