Skip to content

Conversation

@meaghanlewis
Copy link
Contributor

@meaghanlewis meaghanlewis commented Nov 12, 2025

Summary

This pull request updates the .NET CLI documentation to standardize and clarify how package and workload versions are specified, introducing the use of the @ character (e.g., package@version) across several commands. It also updates documentation examples and descriptions to reflect these changes, and adds new guidance and examples for the updated syntax. The changes aim to improve consistency and make it easier for users to specify versions for templates, tools, and workloads.

Key updates by theme:

Standardization of Version Syntax (@ character):

  • Updated the syntax for specifying versions in dotnet new install, dotnet tool install, dotnet tool update, and workload-related commands to use the @ character instead of the deprecated :: separator. This change is reflected in command descriptions and examples, with notes about SDK versions where the new syntax is supported.

Documentation and Example Updates:

  • Updated example commands throughout the documentation to demonstrate the new @ version syntax for installing and updating templates, tools, and workloads.

New and Updated Option Descriptions:

  • Added or updated option descriptions in relevant command docs to explain the use of the @ character for version specification, and referenced the SDK version where this support is available.

General Documentation Maintenance:

  • Updated metadata such as ms.date for several documentation files to reflect the latest revision date.

Workload Command Improvements:

  • Enhanced workload-related docs to include new options and examples for specifying workload versions, including updates to the synopsis and options sections.

These changes ensure that users are guided to use the latest and most consistent syntax for specifying versions in .NET CLI commands.

Fixes #46671


Internal previews

📄 File 🔗 Preview link
docs/core/tools/dotnet-new-install.md dotnet new install
docs/core/tools/dotnet-tool-install.md dotnet tool install
docs/core/tools/dotnet-tool-update.md dotnet tool update command
docs/core/tools/dotnet-workload-install.md dotnet workload install
docs/core/tools/dotnet-workload-search.md docs/core/tools/dotnet-workload-search

@meaghanlewis meaghanlewis marked this pull request as ready for review November 12, 2025 23:16
Copilot AI review requested due to automatic review settings November 12, 2025 23:16
@meaghanlewis meaghanlewis requested a review from a team as a code owner November 12, 2025 23:16
Copilot finished reviewing on behalf of meaghanlewis November 12, 2025 23:18
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This pull request updates the .NET CLI command documentation to standardize version specification syntax by introducing support for the @ character (e.g., package@version) while deprecating the older :: separator. The changes span multiple command reference documents to ensure consistency across the documentation.

Key changes:

  • Introduces a new include file for workload version parameter documentation
  • Updates syntax examples from :: to @ across all affected commands
  • Adds new examples demonstrating the @ syntax for version specification
  • Updates metadata dates to reflect the documentation revision

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
includes/cli-workload-version.md New include file defining the workload version parameter with @ syntax support
docs/core/tools/dotnet-workload-search.md Adds workload version parameter to synopsis and new example using @ syntax
docs/core/tools/dotnet-workload-install.md Replaces generic version include with workload-specific version include and adds @ syntax example
docs/core/tools/dotnet-tool-update.md Updates PACKAGE_ID description with @ syntax guidance and adds new examples
docs/core/tools/dotnet-tool-install.md Updates PACKAGE_ID description with @ syntax guidance and adds new examples
docs/core/tools/dotnet-new-install.md Updates description and arguments to document @ syntax and deprecation of ::, updates examples

Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@meaghanlewis meaghanlewis merged commit 7d1b518 into dotnet:main Nov 14, 2025
9 checks passed
@meaghanlewis meaghanlewis deleted the package-at-version branch November 14, 2025 19:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add @ symbol support to existing .NET CLI command documentation.

2 participants