Skip to content

docs: use descriptive link text for the AI overview page link#69643

Merged
leonsenft merged 1 commit into
angular:mainfrom
erkamyaman:docs-fix-ai-overview-link-text
Jul 6, 2026
Merged

docs: use descriptive link text for the AI overview page link#69643
leonsenft merged 1 commit into
angular:mainfrom
erkamyaman:docs-fix-ai-overview-link-text

Conversation

@erkamyaman

Copy link
Copy Markdown
Contributor

The link on the "develop with AI" page wrapped the verb phrase "to check out the overview page" in the link text, burying the destination in a call-to-action. Per the adev writing guide's descriptive-link-text rule, link only the noun that names the destination.

Change the link text to "overview page" so it clearly indicates where the link goes.

PR Checklist

Please check that your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other

What is the current behavior?

On the "develop with AI" page, the link to the AI overview page uses the link text "to check out the overview page". The link text swallows the verb phrase instead of naming the destination, which reads like a "click here" style call-to-action and contradicts the adev writing guide's guidance to use descriptive link text.

What is the new behavior?

The link text is now just "overview page", so the anchor clearly indicates where the link leads. The surrounding sentence ("Be sure to check out the ...") is unchanged.

Does this PR introduce a breaking change?

  • Yes
  • No

The link on the "develop with AI" page wrapped the verb phrase "to check
out the overview page" in the link text, burying the destination in a
call-to-action. Per the adev writing guide's descriptive-link-text rule,
link only the noun that names the destination.

Change the link text to "overview page" so it clearly indicates where the
link goes.
@pullapprove pullapprove Bot requested a review from josephperrott July 4, 2026 12:55
@angular-robot angular-robot Bot added the area: docs Related to the documentation label Jul 4, 2026
@ngbot ngbot Bot added this to the Backlog milestone Jul 4, 2026
@JeanMeche JeanMeche added action: merge The PR is ready for merge by the caretaker target: patch This PR is targeted for the next patch release target: major This PR is targeted for the next major release labels Jul 4, 2026
@JeanMeche JeanMeche removed the request for review from josephperrott July 4, 2026 12:56
@JeanMeche JeanMeche removed the target: major This PR is targeted for the next major release label Jul 4, 2026
@leonsenft leonsenft merged commit 42fc9a4 into angular:main Jul 6, 2026
30 checks passed
@leonsenft

Copy link
Copy Markdown
Contributor

This PR was merged into the repository. The changes were merged into the following branches:

@erkamyaman erkamyaman deleted the docs-fix-ai-overview-link-text branch July 6, 2026 21:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

action: merge The PR is ready for merge by the caretaker area: docs Related to the documentation target: patch This PR is targeted for the next patch release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants