docs: fix the brokens links on the API pages.

[JeanMeche]

Describe the problem that you experienced

The angular.dev toolchain generates warnings whenever it encounters broken links inside the API entries.

For example:

INFO: From Action packages/common/common_docs_html:
WARNING: ***@link Router*** is invalid, Router is unknown in this context
WARNING: ***@link * Router*** is invalid, * is unknown in this context
WARNING: ***@link Component*** is invalid, Component is unknown in this context
WARNING: ***@link Component*** is invalid, Component is unknown in this context

We'll make this an umbrella issue, to keep track that there is work to do on this side and we'll welcome doc contributions around this !

To run the docs locally, run yarn docs, and check the console for the remaing warnings

[ghost]

@JeanMeche I would like to contribute 👍

[JeanMeche]

Feel free to drop some PR once #57615 is merged !

[Siddharthgup]

Hi @JeanMeche ,I would like to contribute so can you assign me this task ?

[JeevanMahesha]

@JeanMeche, I can see the WARNING messages in the logs. I would like to understand what specific changes need to be made to address the following example log.

Do I need to make any changes to the to_signal.ts file? If so, could you provide an example of the required changes? I will use that as a reference to address the rest of the WARNING messages.

INFO: From Action packages/core/core_docs_html:
WARNING: {@link toSignal} is invalid, toSignal or assertNotInReactiveContext.toSignal is unknown in this context
WARNING: {@link toSignal} is invalid, toSignal or assertNotInReactiveContext.toSignal is unknown in this context
WARNING: {@link toSignal} is invalid, toSignal or assertNotInReactiveContext.toSignal is unknown in this context
WARNING: {@link toSignal} is invalid, toSignal or assertNotInReactiveContext.toSignal is unknown in this context

If possible, could you please assign this issue to me?

[JeanMeche]

In the case where the symbol is unknown (because it's a separate package entry that the current one doesn't rely on), we need to replace the automatic linking with a regular markdown link, eg: [toSignal](/api/core/rxjs-interop/toSignal)

[JeevanMahesha]

@JeanMeche I just synced with the main branch and tried running yarn docs. after the sync I'm unable to see the log. Could you confirm if this might be something on my end?

[JeanMeche]

The logs only appear if the target needs to be rebuilt, else you'll hit the cache (for obvious build performance reasons).

The general go to is to clean the bazel cache with yarn bazel clean --expunge.

[Gitrhyme]

Hey @JeanMeche , I'm interested in helping out with this issue. Would it be okay if I submitted a PR to fix the API links? I began replacing automatic linking with regular markdown, but want to make sure I am not duplicating work if the task is in the works.

Markdown Link:

Clicking on Link:

[angular-automatic-lock-bot[bot]]

This issue has been automatically locked due to inactivity. Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

_{This action has been performed automatically by a bot.}