Improve the generated README.md to be close to Track 2's #895
Conversation
|
|
||
| - [Microsoft Azure SDK for Javascript](https://github.com/Azure/azure-sdk-for-js) | ||
| ## Key concepts |
There was a problem hiding this comment.
Maybe here we can add a reference to Identity so users can refer to to learn how to authenticate
There was a problem hiding this comment.
There is a reference to the docs for the DefaultAzureCredential here. However, I am not sure if @ramya-rao-a wants to keep it. We can continue the discussion in Azure/azure-sdk-for-js#14655.
| * @returns the required getting started section in the readme file | ||
| */ | ||
| function writeGettingStarted(metadata: Metadata): string { | ||
| const text = `## Getting started |
There was a problem hiding this comment.
I have a bit of a general question (for anyone, not specific to this PR) - is it common that we put all the text inline like this when generating static files? Have we explored simple templating engines (remarkable?, handlebars, ejs, etc)
I'm not proposing we go all-in on super complex templates I'm just wondering if that's been explored at all just to separate content/layout from data and (for one example) avoid having to escape backticks everywhere
There was a problem hiding this comment.
We used to have template, if I recall correctly we moved to ts-morph as it allows more flexibility by crafting TS programmatically (@daviwil can correct me here). It may be interesting to do templates for static files though as they are usually not complex.
|
Closing in favor of #971. |
This PR improves the generated README.md to be close to Track 2's ones. In particular:
Getting Started,Key Concepts,Troubleshooting,Next Steps,Contributing, andRelated Projects.Example: Azure/azure-sdk-for-js#14655
Related issue: https://github.com/Azure/azure-sdk-for-js/issues/14449
Swagger
Fixes #594