docs(datasource): All items in the urls array are wrapped between []() character.

[Prtik12]

Fixes #30312

Changes

Updated the formatUrls function to correctly format and escape URLs in the documentation. Fixed bad links and ensured that links in const urls are properly validated.

Context

This PR addresses issues with broken links in the documentation and improves URL formatting to prevent build errors and improve the readability of generated documentation.

Replaces #31161

Documentation (please check one with an [x])

• I have updated the documentation, or
• No documentation update is required

How I've tested my work (please select one)

I have verified these changes via:

• Code inspection only, or
• Newly added/modified unit tests, or
• No unit tests but ran on a real repository, or
• Both unit tests + ran on a real repository

[RahulGautamSingh]

Hey,

Thanks for going the effort to add names to all the urls. 🙌

You will also need to add a test to make sure that all the urls in the versioning & manager module have are wrapped in []() chars.

For this, we will need a test in the modules/versioning/index.spec.ts file (same for managers modules).

Since, this is your first time contributing it could be tiring to figure out how the tests work. Here's an example for the versioning module. Based on it, you can try to write on for the maangers module too.

Add this to the modules/versioning/index.spec.ts file. After this line:

const urlRegex = regEx(/^\[.*\]\(.*\)$/);
    for (const [verName, verModule] of Object.entries(loadedVers)) {
      const urls = (verModule as { urls?: string[] }).urls ?? [];
      for (const url of urls) {
        const urlValid = urlRegex.test(url);
        expect({
          versioning: verName,
          urlValid,
        }).toMatchObject({
          versioning: verName,
          urlValid: true,
        });
      }
    }

It goes through each versioning module, takes the urls field and uses regex matching to check if url is wrapped in []() chars.

[Prtik12]

Hi,
I recently ran the test suite and noticed that one of the tests was skipped. I wanted to ask if the skipped test could have any potential impact on the project or if there are any known issues related to it. Should i be concerned about this, or is there a reason why it's skipped that i should be aware of?

Thanks for your assistance!

[viceice]

revert and do in separate PR

[viceice]

Suggested change

	const urls = (managerModule as { urls?: string[] }).urls ?? [];
	const urls = (managerModule as { urls?: string[] })?.urls ?? [];

why the cast? 🤔 we've an interface for them, see docs generation inside tools folder

[RahulGautamSingh]

Its not needed for the manager module because ManagerApi extends ModuleApi which has the preoperty urls.

But, the VersioningApi is stand-alone and does not extend the ModuleApi, so it doesn't allow the urls property.
Needs to be fixed in diff PR, first Or we could use the Versioning type defined in the tools/docs/versioning.ts

[viceice]

see other comments

[RahulGautamSingh]

Suggested change

	const urls = (managerModule as { urls?: string[] }).urls ?? [];
	const urls = managerModule?.urls ?? [];