Use human-readable link names in Versioning references

[HonkingGoose]

Tell us more.

Intro

Our Versioning docs have a ## References section with links to upstream references.

Those references are "bare links" that are not accessible to screenreader users, or to humans in general.

I would like us to use good, human-readable names in those links instead.

Example

The Renovate docs for azure-rest-api Versioning, has a "bare link":

## References

- https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#api-versioning

Source code for example

I think the source is the modules/versioning/azure-rest-api/index.ts file, that has a const urls array:

renovate/lib/modules/versioning/azure-rest-api/index.ts

Lines 8 to 10 in b053ca5

	export const urls = [
	'https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#api-versioning',
	];

Proposed code fix

Can you have a proper Markdown link in the urls constant? I'm thinking of something like this:

 export const urls = [ 
   '[Microsoft API versioning guidelines](https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#api-versioning)', 
 ]; 

Write failing test first, then fix code

If the above is suitable, we should write a test that deliberately fails first. That way we know that we're actually fixing the problem in each file.

Pseudo-code for failing test:

• IF the index.ts file in the modules/versioning/*/index.ts pattern has a const urls continue, else ignore the file
• Check IF each item in the urls array is wrapped between []() characters
• IF any item in the urls array is not wrapped between []() character: fail test

You may need to adjust the test code so it properly handles cases with only one link, no links, or multiple links. 😉

[HonkingGoose]

I see that @rarkins gave my idea a thumbs up, so I created this issue:

• Replace bare links in index.ts files in the modules/versioning/*/ pattern with good links #30312