Skip to content

Adjust the key link format for modular readme #2885

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MaryGao merged 4 commits into from
Nov 4, 2024
Merged

Adjust the key link format for modular readme #2885

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
15f85a9
remove additional '|'
v-jiaodi Oct 29, 2024
57092ac
update
v-jiaodi Oct 29, 2024
338c74e
fix format
v-jiaodi Oct 29, 2024
b814a64
Merge branch 'main' of https://github.com/Azure/autorest.typescript i…
v-jiaodi Nov 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions packages/rlc-common/src/metadata/buildReadmeFile.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 4 additions & 2 deletions .../typespec-test/test/NetworkAnalytics.Management/generated/typespec-ts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 3 additions & 1 deletion packages/typespec-test/test/anomalyDetector/generated/typespec-ts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 4 additions & 2 deletions packages/typespec-test/test/batch_modular/generated/typespec-ts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 4 additions & 2 deletions packages/typespec-test/test/chatApi_modular/generated/typespec-ts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 4 additions & 2 deletions packages/typespec-test/test/contentsafety_modular/generated/typespec-ts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 3 additions & 1 deletion packages/typespec-test/test/eventgrid_modular/generated/typespec-ts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 4 additions & 2 deletions ...spec-test/test/healthInsights_radiologyinsights/generated/typespec-ts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 3 additions & 1 deletion packages/typespec-test/test/hierarchy_generic/generated/typespec-ts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 4 additions & 2 deletions packages/typespec-test/test/loadtesting_modular/generated/typespec-ts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 3 additions & 1 deletion packages/typespec-test/test/openai_generic/generated/typespec-ts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 3 additions & 1 deletion packages/typespec-test/test/openai_modular/generated/typespec-ts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 3 additions & 1 deletion packages/typespec-test/test/overloads_modular/generated/typespec-ts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 3 additions & 1 deletion packages/typespec-test/test/parametrizedHost/generated/typespec-ts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 3 additions & 1 deletion packages/typespec-test/test/schemaRegistry/generated/typespec-ts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 3 additions & 1 deletion packages/typespec-test/test/spread/generated/typespec-ts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 3 additions & 1 deletion packages/typespec-test/test/widget_dpg/generated/typespec-ts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
⚡