search

Azure / azure-sdk-for-js

This repository is for active development of the Azure SDK for JavaScript (NodeJS & Browser). For consumers of the SDK we recommend visiting our public developer docs at https://docs.microsoft.com/javascript/azure/ or our versioned developer docs at https://azure.github.io/azure-sdk-for-js.
MIT License
2.08k stars 1.2k forks source link

[Readme] multiple links on a single line is hard to read #6449

Closed jeremymeng closed 3 years ago

jeremymeng commented 4 years ago

UX study participants stated that they never look beyond first/second links

image

@HarshaNalluru has a PR to update guidelines in https://github.com/Azure/azure-sdk/pull/754. Once that's approved, we need to update all samples readme

ramya-rao-a commented 3 years ago

The readme policy has been updated as described above. So, we are good to go with the changes.

Files to update:

bashimoha commented 3 years ago

Can you please assign to me If no one is working on it.

ramya-rao-a commented 3 years ago

@bashimoha Sure, thanks for considering to contribute! Please send separate PRs for each package you want to update.

bashimoha commented 3 years ago

When you said packages can I assume that means every folder with the package.json and also can I include a h2 tag before the important links?

like this? Thank you!

Key links

jeremymeng commented 3 years ago

@bashimoha The readme guideline suggests to include the list of links at the bottom of the introduction, i.e., without a heading.

Regarding packages, there's a list of files above, although there might be new packages now that are not included in the list.

bashimoha commented 3 years ago

okay, thank you so much

jeremymeng commented 3 years ago

I generated a list of links for client packages from current rush.json