Skip to content

[TCGC] Doc auto-update agent #3868

@tadelesh

Description

@tadelesh

We have several parts of docs for TCGC:

  1. User doc under https://github.com/Azure/typespec-azure/tree/main/website/src/content/docs/docs/howtos/Generate%20client%20libraries which tell TypeSpec user how a spec will be generated to a client code and how to customize the generation.
  2. Doc for emitter dev: https://github.com/Azure/typespec-azure/blob/main/website/src/content/docs/docs/libraries/typespec-client-generator-core/guideline.md which show the export types and meanings for TCGC.
  3. Design docs: https://github.com/Azure/typespec-azure/tree/main/packages/typespec-client-generator-core/design-docs which are detailed designs for TCGC feature

We have Spector samples to show the functionality of TCGC's feature: https://github.com/Azure/typespec-azure/tree/main/packages/azure-http-specs/specs.

And, TCGC has many code based document and test case which strongly align with the TCGC's features.

For all above, current satiation is they are all not so complete and update to date.

We want to have an agent to gradually check them and help to update them.

Metadata

Metadata

Assignees

Labels

lib:tcgcIssues for @azure-tools/typespec-client-generator-core library

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions