docs-infra: potential improvements in generated JSON files for docs

[gkalpak]

Description

While investigating #28114, we found out about the following potential improvements to the generated JSON files (/generated/docs/**/*.json). See also #28114 (comment).

• The renderLinkInfo Dgeni processor renders an HTML comment with all links found in the document at the bottom of the HTML content. This unnecessarily increases the payload size of each document (which affects both the download times and the cache sizes for the SW).
  (NOTE: Since we include two links (view/edit) for each property/method/overload signature, some API docs end up with a lot of such links.)

• The URLs for the links to view/edit the source code on GitHub contain the current version of Angular (see the githubViewRef() macro). This means that on every release (including patch releases), the contents of almost all docs files change, thus invalidating their content-based hashes (and by extension invalidating any cached versions of the files).
  Potential fixes:

  • Replace the Dgeni macro by a custom element. (Potentially problematic on pages with many instances, due to elements: too many change detection runs during initialization #33059 and elements: no coalescing of change detection invocations across instances #33060.)
  • Remove the version from the URLs and use the branch name instead. (Less accurate, but easy to implement and still low likelihood of error.)
  • Use a placeholder and dynamically replace it in DocumentService#fetchDocument().

What is the affected URL?

Almost all 😁

Please provide the steps to reproduce the issue

No response

Please provide the expected behavior vs the actual behavior you encountered

No response

Please provide a screenshot if possible

No response

Please provide the exception or error you saw

No response

Is this a browser-specific issue? If so, please specify the device, browser, and version.

No response

[angular-automatic-lock-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.}