Adjust the key link format for modular readme (#2885)

* remove additional '|' * update * fix format
Azure · Nov 4, 2024 · 63b29f2 · 63b29f2
1 parent 3d019a6
commit 63b29f2
Show file tree

Hide file tree

Showing 17 changed files with 60 additions and 26 deletions.
diff --git a/packages/rlc-common/src/metadata/buildReadmeFile.ts b/packages/rlc-common/src/metadata/buildReadmeFile.ts
@@ -92,17 +92,19 @@ This package contains an isomorphic SDK (runs both in Node.js and in browsers) f
 
 {{ description }}
 
+Key links:
+
 {{#if packageSourceURL}}
-[Source code]({{ packageSourceURL }}) |
+- [Source code]({{ packageSourceURL }})
 {{/if}}
 {{#if packageNPMURL}}
-[Package (NPM)]({{ packageNPMURL }}) |
+- [Package (NPM)]({{ packageNPMURL }})
 {{/if}}
 {{#if apiRefURL}}
-[API reference documentation]({{ apiRefURL }}) |
+- [API reference documentation]({{ apiRefURL }})
 {{/if}}
 {{#if samplesURL}}
-[Samples]({{samplesURL}})
+- [Samples]({{samplesURL}})
 {{/if}}
 
 ## Getting started

diff --git a/.../typespec-test/test/NetworkAnalytics.Management/generated/typespec-ts/README.md b/.../typespec-test/test/NetworkAnalytics.Management/generated/typespec-ts/README.md
@@ -4,8 +4,10 @@ This package contains an isomorphic SDK (runs both in Node.js and in browsers) f
 
 
 
-[Package (NPM)](https://www.npmjs.com/package/@azure/arm-networkanalytics) |
-[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-networkanalytics?view=azure-node-preview) |
+Key links:
+
+- [Package (NPM)](https://www.npmjs.com/package/@azure/arm-networkanalytics)
+- [API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-networkanalytics?view=azure-node-preview)
 
 ## Getting started
 

diff --git a/packages/typespec-test/test/anomalyDetector/generated/typespec-ts/README.md b/packages/typespec-test/test/anomalyDetector/generated/typespec-ts/README.md
@@ -19,7 +19,9 @@ a kind of group based detection, this detection will find inconsistency ones in
 a set of time series. By using anomaly detector service, business customers can
 discover incidents and establish a logic flow for root cause analysis.
 
-[Package (NPM)](https://www.npmjs.com/package/@msinternal/ai-anomaly-detector) |
+Key links:
+
+- [Package (NPM)](https://www.npmjs.com/package/@msinternal/ai-anomaly-detector)
 
 ## Getting started
 

diff --git a/packages/typespec-test/test/batch_modular/generated/typespec-ts/README.md b/packages/typespec-test/test/batch_modular/generated/typespec-ts/README.md
@@ -4,8 +4,10 @@ This package contains an isomorphic SDK (runs both in Node.js and in browsers) f
 
 Azure Batch provides Cloud-scale job scheduling and compute management.
 
-[Package (NPM)](https://www.npmjs.com/package/@azure-rest/batch) |
-[API reference documentation](https://docs.microsoft.com/javascript/api/@azure-rest/batch?view=azure-node-preview) |
+Key links:
+
+- [Package (NPM)](https://www.npmjs.com/package/@azure-rest/batch)
+- [API reference documentation](https://docs.microsoft.com/javascript/api/@azure-rest/batch?view=azure-node-preview)
 
 ## Getting started
 

diff --git a/packages/typespec-test/test/chatApi_modular/generated/typespec-ts/README.md b/packages/typespec-test/test/chatApi_modular/generated/typespec-ts/README.md
@@ -4,8 +4,10 @@ This package contains an isomorphic SDK (runs both in Node.js and in browsers) f
 
 Azure APIs for the Azure Chat protocol.
 
-[Package (NPM)](https://www.npmjs.com/package/@azure/ai-chat-protocol) |
-[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/ai-chat-protocol?view=azure-node-preview) |
+Key links:
+
+- [Package (NPM)](https://www.npmjs.com/package/@azure/ai-chat-protocol)
+- [API reference documentation](https://docs.microsoft.com/javascript/api/@azure/ai-chat-protocol?view=azure-node-preview)
 
 ## Getting started
 

diff --git a/packages/typespec-test/test/contentsafety_modular/generated/typespec-ts/README.md b/packages/typespec-test/test/contentsafety_modular/generated/typespec-ts/README.md
@@ -4,8 +4,10 @@ This package contains an isomorphic SDK (runs both in Node.js and in browsers) f
 
 Analyze harmful content
 
-[Package (NPM)](https://www.npmjs.com/package/@azure-rest/ai-content-safety) |
-[API reference documentation](https://docs.microsoft.com/javascript/api/@azure-rest/ai-content-safety) |
+Key links:
+
+- [Package (NPM)](https://www.npmjs.com/package/@azure-rest/ai-content-safety)
+- [API reference documentation](https://docs.microsoft.com/javascript/api/@azure-rest/ai-content-safety)
 
 ## Getting started
 

diff --git a/packages/typespec-test/test/eventgrid_modular/generated/typespec-ts/README.md b/packages/typespec-test/test/eventgrid_modular/generated/typespec-ts/README.md
@@ -4,7 +4,9 @@ This package contains an isomorphic SDK (runs both in Node.js and in browsers) f
 
 Azure Messaging EventGrid Client
 
-[Package (NPM)](https://www.npmjs.com/package/@msinternal/eventgrid) |
+Key links:
+
+- [Package (NPM)](https://www.npmjs.com/package/@msinternal/eventgrid)
 
 ## Getting started
 

diff --git a/...spec-test/test/healthInsights_radiologyinsights/generated/typespec-ts/README.md b/...spec-test/test/healthInsights_radiologyinsights/generated/typespec-ts/README.md
@@ -4,8 +4,10 @@ This package contains an isomorphic SDK (runs both in Node.js and in browsers) f
 
 Azure AI Health Insights provides an API that serves insight models, specific for Health & Life Sciences, that perform analysis and provide inferences to be used by a human.
 
-[Package (NPM)](https://www.npmjs.com/package/@azure-rest/health-insights-radiologyinsights) |
-[API reference documentation](https://docs.microsoft.com/javascript/api/@azure-rest/health-insights-radiologyinsights?view=azure-node-preview) |
+Key links:
+
+- [Package (NPM)](https://www.npmjs.com/package/@azure-rest/health-insights-radiologyinsights)
+- [API reference documentation](https://docs.microsoft.com/javascript/api/@azure-rest/health-insights-radiologyinsights?view=azure-node-preview)
 
 ## Getting started
 

diff --git a/packages/typespec-test/test/hierarchy_generic/generated/typespec-ts/README.md b/packages/typespec-test/test/hierarchy_generic/generated/typespec-ts/README.md
@@ -4,7 +4,9 @@ This package contains an isomorphic SDK (runs both in Node.js and in browsers) f
 
 OpenAI
 
-[Package (NPM)](https://www.npmjs.com/package/@msinternal/hierarchy-generic) |
+Key links:
+
+- [Package (NPM)](https://www.npmjs.com/package/@msinternal/hierarchy-generic)
 
 ## Getting started
 

diff --git a/packages/typespec-test/test/loadtesting_modular/generated/typespec-ts/README.md b/packages/typespec-test/test/loadtesting_modular/generated/typespec-ts/README.md
@@ -4,8 +4,10 @@ This package contains an isomorphic SDK (runs both in Node.js and in browsers) f
 
 These APIs allow end users to create, view and run load tests using Azure Load Test Service.
 
-[Package (NPM)](https://www.npmjs.com/package/@azure/load-testing) |
-[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/load-testing) |
+Key links:
+
+- [Package (NPM)](https://www.npmjs.com/package/@azure/load-testing)
+- [API reference documentation](https://docs.microsoft.com/javascript/api/@azure/load-testing)
 
 ## Getting started
 

diff --git a/packages/typespec-test/test/openai_generic/generated/typespec-ts/README.md b/packages/typespec-test/test/openai_generic/generated/typespec-ts/README.md
@@ -4,7 +4,9 @@ This package contains an isomorphic SDK (runs both in Node.js and in browsers) f
 
 The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.
 
-[Package (NPM)](https://www.npmjs.com/package/@msinternal/openai-generic) |
+Key links:
+
+- [Package (NPM)](https://www.npmjs.com/package/@msinternal/openai-generic)
 
 ## Getting started
 

diff --git a/packages/typespec-test/test/openai_modular/generated/typespec-ts/README.md b/packages/typespec-test/test/openai_modular/generated/typespec-ts/README.md
@@ -4,7 +4,9 @@ This package contains an isomorphic SDK (runs both in Node.js and in browsers) f
 
 Azure OpenAI APIs for completions and search
 
-[Package (NPM)](https://www.npmjs.com/package/@msinternal/openai_modular) |
+Key links:
+
+- [Package (NPM)](https://www.npmjs.com/package/@msinternal/openai_modular)
 
 ## Getting started
 

diff --git a/packages/typespec-test/test/overloads_modular/generated/typespec-ts/README.md b/packages/typespec-test/test/overloads_modular/generated/typespec-ts/README.md
@@ -4,7 +4,9 @@ This package contains an isomorphic SDK (runs both in Node.js and in browsers) f
 
 Mock Service
 
-[Package (NPM)](https://www.npmjs.com/package/@msinternal/overload_modular) |
+Key links:
+
+- [Package (NPM)](https://www.npmjs.com/package/@msinternal/overload_modular)
 
 ## Getting started
 

diff --git a/packages/typespec-test/test/parametrizedHost/generated/typespec-ts/README.md b/packages/typespec-test/test/parametrizedHost/generated/typespec-ts/README.md
@@ -4,7 +4,9 @@ This package contains an isomorphic SDK (runs both in Node.js and in browsers) f
 
 Parametrized host test
 
-[Package (NPM)](https://www.npmjs.com/package/@msinternal/parametrized-host) |
+Key links:
+
+- [Package (NPM)](https://www.npmjs.com/package/@msinternal/parametrized-host)
 
 ## Getting started
 

diff --git a/packages/typespec-test/test/schemaRegistry/generated/typespec-ts/README.md b/packages/typespec-test/test/schemaRegistry/generated/typespec-ts/README.md
@@ -4,7 +4,9 @@ This package contains an isomorphic SDK (runs both in Node.js and in browsers) f
 
 SchemaRegistryClient is a client for registering and retrieving schemas from the Azure Schema Registry service.
 
-[Package (NPM)](https://www.npmjs.com/package/@msinternal/schema-registry) |
+Key links:
+
+- [Package (NPM)](https://www.npmjs.com/package/@msinternal/schema-registry)
 
 ## Getting started
 

diff --git a/packages/typespec-test/test/spread/generated/typespec-ts/README.md b/packages/typespec-test/test/spread/generated/typespec-ts/README.md
@@ -4,7 +4,9 @@ This package contains an isomorphic SDK (runs both in Node.js and in browsers) f
 
 
 
-[Package (NPM)](https://www.npmjs.com/package/@msinternal/spread) |
+Key links:
+
+- [Package (NPM)](https://www.npmjs.com/package/@msinternal/spread)
 
 ## Getting started
 

diff --git a/packages/typespec-test/test/widget_dpg/generated/typespec-ts/README.md b/packages/typespec-test/test/widget_dpg/generated/typespec-ts/README.md
@@ -4,7 +4,9 @@ This package contains an isomorphic SDK (runs both in Node.js and in browsers) f
 
 Widget Service
 
-[Package (NPM)](https://www.npmjs.com/package/@msinternal/widget_dpg) |
+Key links:
+
+- [Package (NPM)](https://www.npmjs.com/package/@msinternal/widget_dpg)
 
 ## Getting started