Content-Length: 223630 | pFad | http://github.com/angular/angular/issues/61710

B7 Add link with absolute URL to docs on each public API · Issue #61710 · angular/angular · GitHub
Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yjaaidi opened this issue May 27, 2025 · 0 comments
Open

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

yjaaidi opened this issue May 27, 2025 · 0 comments
Labels
area: docs Related to the documentation
Milestone

Comments

@yjaaidi
Copy link
Contributor

yjaaidi commented May 27, 2025

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
@JeanMeche JeanMeche added area: dev-infra Issues related to Angular's own dev infra (build, test, CI, releasing) area: docs Related to the documentation labels May 28, 2025
@ngbot ngbot bot modified the milestone: needsTriage May 28, 2025
@JeanMeche JeanMeche removed the area: dev-infra Issues related to Angular's own dev infra (build, test, CI, releasing) label May 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs Related to the documentation
Projects
None yet
Development

No branches or pull requests

2 participants








ApplySandwichStrip

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier!      Saves Data!


--- a PPN by Garber Painting Akron. With Image Size Reduction included!

Fetched URL: http://github.com/angular/angular/issues/61710

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy