Update includes files for .NET CLI #50088
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adegeo
approved these changes
Nov 21, 2025
Contributor
adegeo
left a comment
adegeo
left a comment
There was a problem hiding this comment.
Approving to unblock. A few minor things to fix.
GREAT JOB!
meaghanlewis
changed the title
Copilot finished reviewing on behalf of
meaghanlewis
November 21, 2025 23:32
Contributor
There was a problem hiding this comment.
Pull request overview
This PR standardizes the .NET CLI documentation by moving shared option and argument descriptions into reusable include files. The changes improve maintainability by centralizing commonly repeated content like --help, --interactive, --verbosity, and other standard CLI options.
Key Changes:
- Modified include files to remove the list item marker (
-) from the beginning of the option definition - Updated all referencing documentation files to add the list item marker (
-) before the[!INCLUDE ...]statement - Deleted redundant include files (
cli-interactive-3-0.md,cli-interactive-5-0.md,cli-arch-no-a.md) in favor of the base versions
Reviewed changes
Copilot reviewed 97 out of 97 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| includes/*.md (29 files) | Removed list item markers from option definitions to enable proper list formatting when included |
| docs/core/tools/dotnet-build.md | Added list markers before include statements for standardized options |
| docs/core/tools/dotnet-clean.md | Added list markers before include statements for standardized options |
| docs/core/tools/dotnet-format.md | Added list markers before include statements for standardized options |
| docs/core/tools/dotnet-help.md | Added list markers before include statements for standardized options |
| docs/core/tools/dotnet-new*.md (7 files) | Added list markers before include statements for standardized options |
| docs/core/tools/dotnet-nuget*.md (14 files) | Added list markers before include statements for standardized options |
| docs/core/tools/dotnet-pack.md | Added list markers before include statements for standardized options |
| docs/core/tools/dotnet-package*.md (5 files) | Added list markers before include statements for standardized options |
| docs/core/tools/dotnet-publish.md | Added list markers before include statements for standardized options |
| docs/core/tools/dotnet-reference*.md (3 files) | Added list markers before include statements for standardized options |
| docs/core/tools/dotnet-restore.md | Added list markers before include statements for standardized options |
| docs/core/tools/dotnet-run.md | Added list markers before include statements for standardized options |
| docs/core/tools/dotnet-sdk-check.md | Added list markers before include statements for standardized options |
| docs/core/tools/dotnet-sln.md | Added list markers before include statements for standardized options |
| docs/core/tools/dotnet-store.md | Added list markers before include statements for standardized options |
| docs/core/tools/dotnet-test.md | Added list markers before include statements for standardized options |
| docs/core/tools/dotnet-tool*.md (8 files) | Added list markers before include statements for standardized options |
| docs/core/tools/dotnet-watch.md | Added list markers before include statements for standardized options |
| docs/core/tools/dotnet-workload*.md (8 files) | Added list markers before include statements for standardized options |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This pull request updates several .NET CLI documentation files to standardize the usage of shared option and argument descriptions. The main change is replacing manually written option and argument descriptions with consistent
[!INCLUDE ...]statements that reference shared markdown include files. This improves maintainability and consistency across the documentation.Standardization of CLI option/argument documentation:
--help,--configfile, and--interactivewith[!INCLUDE ...]statements in multiple command docs, includingdotnet build,dotnet clean,dotnet format,dotnet help, and variousdotnet nugetcommands.These changes make the CLI documentation easier to maintain and more consistent for users.
Fixes #49500
Internal previews
Toggle expand/collapse
Note
This table shows preview links for the 30 files with the most changes. For preview links for other files in this PR, select OpenPublishing.Build Details within checks.