Skip to content

Extended diagnostics should link to angular.dev documentation #45033

@dgp1130

Description

@dgp1130

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

compiler-cli

Description

Extended diagnostics have fairly comprehensive documentation on https://angular.io/extended-diagnostics/, with a page for each error code. These include explanations of exactly why the pattern is bad, what users can do about it, and how to suppress it if necessary. Currently however, users get only an error message in their console / IDE. This is hopefully expressive enough for many users, but it is not as comprehensive as AIO, and we should be pointing users to that documentation if they have any questions.

Proposed solution

Extended diagnostics should include a link to their AIO page. Ideally, this is something they can do automatically in a common format so future diagnostics implicitly get this link and incentivize the team to continue to write comprehensive documentation about these checks.

Alternatives considered

N/A

Metadata

Metadata

Assignees

Labels

area: compilerIssues related to `ngc`, Angular's template compilerfeatureLabel used to distinguish feature request from other issuesfeature: under considerationFeature request for which voting has completed and the request is now under consideration

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions