Skip to content

docs: update long-description#32768

Open
SkyZeroZx wants to merge 1 commit intoangular:mainfrom
SkyZeroZx:docs/update-docs-cli
Open

docs: update long-description#32768
SkyZeroZx wants to merge 1 commit intoangular:mainfrom
SkyZeroZx:docs/update-docs-cli

Conversation

@SkyZeroZx
Copy link

What is the current behavior?

image

What is the new behavior?

Avoid using absolute links in angular.dev since this is an internal route.

image

@angular-robot angular-robot bot added the area: docs Related to the documentation label Mar 14, 2026
Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the documentation for the ng update command. The changes involve updating an example version from 10 to 21 and converting an absolute URL for the Angular Update Guide to a relative path. While the link change is a good improvement, the hardcoded version number in the example could quickly become outdated. I've provided a suggestion to rephrase the example to make it more robust and clearer for users.


We recommend that you always update to the latest patch version, as it contains fixes we released since the initial major release.
For example, use the following command to take the latest 10.x.x version and use that to update.
For example, use the following command to take the latest 21.x.x version and use that to update.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

While updating the version number makes the example more current, hardcoding a specific version like 21 can quickly become outdated and potentially confuse users if it doesn't align with the actual latest version. To make the documentation more timeless, consider rephrasing to make it clearer that this is an example of how to use the <major_version> placeholder mentioned above.

Suggested change
For example, use the following command to take the latest 21.x.x version and use that to update.
For example, to update to major version 21, you would use:

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Try just keeping it updated by updating the number; I'm not sure if we should change it.

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

Successfully merging this pull request may close these issues.

1 participant