-
Notifications
You must be signed in to change notification settings - Fork 6k
Add missing documentation for sln, buildprops, and buildtargets item templates #48191
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Co-authored-by: baronfel <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@copilot the new templates need to be added to or linked from the existing includes/templates.md table of contents
…ntation Co-authored-by: baronfel <[email protected]>
Added the |
includes/templates.md
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should the templates in the table be listed alphabetically to make it easier to find what you're looking for?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like that idea!
@@ -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` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That would mean that there is a single H2 in the entire article and that the TOC on the right-side is useless. Considering each section here is a template itself, I think it makes sense to keep them as H2.
Co-authored-by: Genevieve Warren <[email protected]>
This PR adds comprehensive documentation for three .NET SDK item templates that were missing from the official documentation:
buildprops
templateDirectory.Build.props
file for customizing MSBuild properties across an entire folder tree--inherit
option for importing parent Directory.Build.props files--use-artifacts
option for enabling artifacts output layout with reference to artifacts documentationbuildtargets
templateDirectory.Build.targets
file for customizing MSBuild targets and tasks across an entire folder tree--inherit
option for importing parent Directory.Build.targets filessln
template--format
option available in .NET SDK 9.0.200+ for choosing betweensln
andslnx
formatsslnx
formatDocumentation Updates
includes/templates.md
with proper cross-references--use-artifacts
option description with a link to the artifacts output layout documentationAll 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
dotnet new