Add missing documentation for sln, buildprops, and buildtargets item templates #48191

Copilot · 2025-08-29T19:21:03Z

This PR adds comprehensive documentation for three .NET SDK item templates that were missing from the official documentation:

`buildprops` template

Creates a Directory.Build.props file for customizing MSBuild properties across an entire folder tree
Documents the --inherit option for importing parent Directory.Build.props files
Documents the --use-artifacts option for enabling artifacts output layout with reference to artifacts documentation
Added in .NET SDK 8.0.100

`buildtargets` template

Creates a Directory.Build.targets file for customizing MSBuild targets and tasks across an entire folder tree
Documents the --inherit option for importing parent Directory.Build.targets files
Added in .NET SDK 8.0.100

`sln` template

Creates an empty solution file containing no projects
Documents the --format option available in .NET SDK 9.0.200+ for choosing between sln and slnx formats
Notes that .NET 10 will default to slnx format

Documentation Updates

Added the new templates to the templates table of contents in includes/templates.md with proper cross-references
Enhanced the --use-artifacts option description with a link to the artifacts output layout documentation
All sections follow existing documentation patterns with clear descriptions and detailed option explanations

All template options have been tested and verified for accuracy using the actual .NET SDK commands.

Fixes #48190.

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Internal previews

📄 File	🔗 Preview link
docs/core/tools/dotnet-new-sdk-templates.md	docs/core/tools/dotnet-new-sdk-templates

Co-authored-by: baronfel <[email protected]>

baronfel

@copilot the new templates need to be added to or linked from the existing includes/templates.md table of contents

docs/core/tools/dotnet-new-sdk-templates.md

…ntation Co-authored-by: baronfel <[email protected]>

Copilot · 2025-08-29T19:38:43Z

@copilot the new templates need to be added to or linked from the existing includes/templates.md table of contents

Added the buildprops and buildtargets templates to the templates.md table of contents with proper links to their documentation sections. The sln template was already listed but now has the correct link. Changes committed in 4891e45.

gewarren · 2025-08-30T00:22:18Z

docs/core/tools/dotnet-new-sdk-templates.md

@@ -3,7 +3,7 @@ title: .NET default templates for dotnet new
 description: The information about dotnet new templates shipped with dotnet SDK.
 ms.custom: updateeachrelease
 no-loc: [Blazor, WebAssembly]
-ms.date: 02/21/2024
+ms.date: 08/29/2024


Suggested change

ms.date: 08/29/2024

ms.date: 08/29/2025

gewarren · 2025-08-30T00:25:32Z

docs/core/tools/dotnet-new-sdk-templates.md

+Creates an empty solution file containing no projects.
+
+> [!NOTE]
+> In .NET SDK 9.0.200 and later, this template supports a `--format` option to choose between `sln` and `slnx` formats. Starting with .NET 10, the default format will be `slnx`.


Suggested change

> In .NET SDK 9.0.200 and later, this template supports a `--format` option to choose between `sln` and `slnx` formats. Starting with .NET 10, the default format will be `slnx`.

> In .NET SDK 9.0.200 and later, this template supports a `--format` option to choose between `sln` and `slnx` formats. Starting with .NET 10, the default format is `slnx`.

gewarren · 2025-08-30T00:33:07Z

docs/core/tools/dotnet-new-sdk-templates.md

@@ -3,7 +3,7 @@ title: .NET default templates for dotnet new
 description: The information about dotnet new templates shipped with dotnet SDK.
 ms.custom: updateeachrelease
 no-loc: [Blazor, WebAssembly]
-ms.date: 02/21/2024
+ms.date: 08/29/2024
 ---
 # .NET default templates for dotnet new


I know it's unrelated to the changes, but seems like the title could just be:

Suggested change

# .NET default templates for dotnet new

# Default templates for `dotnet new`

And then the TOC entry at

docs/docs/navigate/tools-diagnostics/toc.yml

Line 139 in 6b7617a

- name: .NET default templates

should also be updated to just "Default templates".

gewarren · 2025-08-30T00:40:18Z

includes/templates.md

Should the templates in the table be listed alphabetically to make it easier to find what you're looking for?

gewarren · 2025-08-30T00:46:54Z

docs/core/tools/dotnet-new-sdk-templates.md

@@ -21,6 +21,30 @@ Each template may have additional options available. To show the additional opti
 In case the template supports multiple languages, this command will show help for the template in the default language. By combining it with the `--language` option, you can see the help for other languages: `dotnet new console --help --language F#`.
 The templates that ship with the .NET SDK have the following additional options:


Suggested change

The templates that ship with the .NET SDK have the following additional options:

The templates that ship with the .NET SDK have additional options that are described in the following sections.

gewarren · 2025-08-30T00:47:46Z

docs/core/tools/dotnet-new-sdk-templates.md

@@ -21,6 +21,30 @@ Each template may have additional options available. To show the additional opti
 In case the template supports multiple languages, this command will show help for the template in the default language. By combining it with the `--language` option, you can see the help for other languages: `dotnet new console --help --language F#`.
 The templates that ship with the .NET SDK have the following additional options:

+## `buildprops`


Since all of these sections are really about the options for each template, I feel like each template heading should be an H3, not an H2, to make them subheadings of ## Template options.

Initial plan

adb634d

Copilot AI assigned Copilot and baronfel Aug 29, 2025

Copilot started work on behalf of baronfel August 29, 2025 19:21 View session

Add documentation for buildprops, buildtargets, and sln templates

b3928f5

Co-authored-by: baronfel <[email protected]>

dotnet-policy-service bot added dotnet-fundamentals/svc dotnet-cli/subsvc labels Aug 29, 2025

Copilot AI changed the title ~~[WIP] Add missing documentation for sln, buildprops, and buildtargets item templates~~ Add missing documentation for sln, buildprops, and buildtargets item templates Aug 29, 2025

Copilot AI requested a review from baronfel August 29, 2025 19:31

Copilot finished work on behalf of baronfel August 29, 2025 19:31

baronfel reviewed Aug 29, 2025

View reviewed changes

docs/core/tools/dotnet-new-sdk-templates.md Outdated Show resolved Hide resolved

Copilot started work on behalf of baronfel August 29, 2025 19:34 View session

Add new templates to table of contents and reference artifacts docume…

4891e45

…ntation Co-authored-by: baronfel <[email protected]>

Copilot finished work on behalf of baronfel August 29, 2025 19:39

Copilot AI requested a review from baronfel August 29, 2025 19:39

baronfel marked this pull request as ready for review August 29, 2025 19:45

baronfel requested review from adegeo and a team as code owners August 29, 2025 19:45

baronfel approved these changes Aug 29, 2025

View reviewed changes

gewarren reviewed Aug 30, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add missing documentation for sln, buildprops, and buildtargets item templates #48191

Add missing documentation for sln, buildprops, and buildtargets item templates #48191

Copilot AI commented Aug 29, 2025 •

edited by github-actions bot

Loading

Uh oh!

baronfel left a comment

Uh oh!

Uh oh!

Copilot AI commented Aug 29, 2025

Uh oh!

gewarren Aug 30, 2025

Uh oh!

gewarren Aug 30, 2025

Uh oh!

gewarren Aug 30, 2025

Uh oh!

gewarren Aug 30, 2025

Uh oh!

gewarren Aug 30, 2025

Uh oh!

gewarren Aug 30, 2025

Uh oh!

gewarren Aug 30, 2025

Uh oh!

Uh oh!

	> In .NET SDK 9.0.200 and later, this template supports a `--format` option to choose between `sln` and `slnx` formats. Starting with .NET 10, the default format will be `slnx`.
	> In .NET SDK 9.0.200 and later, this template supports a `--format` option to choose between `sln` and `slnx` formats. Starting with .NET 10, the default format is `slnx`.

	# .NET default templates for dotnet new
	# Default templates for `dotnet new`

		@@ -21,6 +21,30 @@ Each template may have additional options available. To show the additional opti
		In case the template supports multiple languages, this command will show help for the template in the default language. By combining it with the `--language` option, you can see the help for other languages: `dotnet new console --help --language F#`.
		The templates that ship with the .NET SDK have the following additional options:

Add missing documentation for sln, buildprops, and buildtargets item templates #48191

Are you sure you want to change the base?

Add missing documentation for sln, buildprops, and buildtargets item templates #48191

Conversation

Copilot AI commented Aug 29, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

buildprops template

buildtargets template

sln template

Documentation Updates

Internal previews

Uh oh!

baronfel left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI commented Aug 29, 2025

Uh oh!

gewarren Aug 30, 2025

Choose a reason for hiding this comment

Uh oh!

gewarren Aug 30, 2025

Choose a reason for hiding this comment

Uh oh!

gewarren Aug 30, 2025

Choose a reason for hiding this comment

Uh oh!

gewarren Aug 30, 2025

Choose a reason for hiding this comment

Uh oh!

gewarren Aug 30, 2025

Choose a reason for hiding this comment

Uh oh!

gewarren Aug 30, 2025

Choose a reason for hiding this comment

Uh oh!

gewarren Aug 30, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI commented Aug 29, 2025 •

edited by github-actions bot

Loading

`buildprops` template

`buildtargets` template

`sln` template