Skip to content

Add link with absolute URL to docs on each public API #61710

@yjaaidi

Description

@yjaaidi

Which @angular/* package(s) are relevant/related to the feature request?

No response

Description

Docs are not easily discoverable from the IDE.

Proposed solution

It would be nice if each public API had a link in its jsdoc pointing to the docs. e.g. @see {@link https://v20.angular.dev/api/…}

The link would then be visible to anyone hovering a public API in most IDEs.

It would be useful because:

  • it can target the right version directly
  • users get less hijacked by other resources by searching or prompting
  • users might read the docs more frequently

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: docsRelated to the documentation

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions