search

Azure / azure-sdk-tools

Tools repository leveraged by the Azure SDK team.
MIT License
114 stars 180 forks source link

Improve entry point documentation to SDK generation from API spec #9383

Open maririos opened 1 week ago

maririos commented 1 week ago

Now that our users are using Typespec, we need to guide them on documentation to configure the emitters in their projects. The current entry point is: https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/Getting-started-with-TypeSpec-specifications.md#arm which doesn't explain too much.

Things to add:

Should we move this documentation to EngHub too?

raych1 commented 1 week ago

This is the entry page for TypeSpec in EngHub site, which includes more information about other areas.

This one is more about how to work with TypeSpec in spec repo. I would suggest to add reference to this document for other knowledges, such as how to write SDK emitter configurations.

maririos commented 1 week ago

This one is more about how to work with TypeSpec in spec repo. I would suggest to add reference to this document for other knowledges, such as how to write SDK emitter configurations.

You mean doing a different document specific to this, right? if so yes I agree

raych1 commented 3 days ago

Yes, I recommend having a different page specific to the SDK emitter configurations.