Skip to content

Conversation

@meaghanlewis
Copy link
Contributor

@meaghanlewis meaghanlewis commented Oct 23, 2025

Summary

This pull request updates several .NET tutorial documentation files to improve clarity, consistency, and formatting. The changes include refining instructional language, updating prerequisite sections, correcting grammar, and standardizing step numbering. Additionally, metadata such as dates and AI usage attribution have been updated across multiple files.

Documentation improvements and clarification:

  • Refined instructional language throughout tutorials, including changing phrases like "you'll learn how to" to "you learn how to," and simplifying descriptions to improve readability in files such as cli-templates-create-item-template.md, cli-templates-create-project-template.md, and cli-templates-create-template-package.md. [1] [2] [3]
  • Improved grammar and clarity in step-by-step instructions, such as updating step numbering from "01." to "1." and rephrasing sentences for directness and simplicity. [1] [2]

Metadata and attribution updates:

  • Updated the ms.date field to "10/23/2025" and added ai-usage: ai-assisted attribution in documentation files to reflect current editorial standards. [1] [2] [3] [4] [5] [6] [7]

Consistency and formatting:

  • Standardized prerequisite sections by removing unnecessary indentation, bullet points, and improving sentence structure for clarity in multiple tutorials. [1] [2] [3] [4] [5]
  • Improved grammar and wording in various places, such as using "that's your preferred experience" instead of "that is your preferred experience," and clarifying references to related guides. [1] [2] [3]

These changes collectively enhance the overall quality and consistency of the .NET tutorial documentation.

Fixes #48755


Internal previews

Toggle expand/collapse
📄 File 🔗 Preview link
docs/core/tutorials/cli-templates-create-item-template.md Tutorial: Create an item template
docs/core/tutorials/cli-templates-create-project-template.md Create a project template for dotnet new
docs/core/tutorials/cli-templates-create-template-package.md Tutorial: Create a template package
docs/core/tutorials/creating-app-with-plugin-support.md docs/core/tutorials/creating-app-with-plugin-support
docs/core/tutorials/debugging-with-visual-studio-code.md Tutorial: Debug a .NET console application using Visual Studio Code
docs/core/tutorials/debugging-with-visual-studio.md Debug a .NET console application using Visual Studio
docs/core/tutorials/index.md Learn .NET and the .NET SDK tools by exploring these tutorials
docs/core/tutorials/libraries.md docs/core/tutorials/libraries
docs/core/tutorials/library-with-visual-studio.md Tutorial: Create a .NET class library using Visual Studio
docs/core/tutorials/netcore-hosting.md Write a custom .NET runtime host
docs/core/tutorials/publishing-with-visual-studio.md Tutorial: Publish a .NET console application using Visual Studio
docs/core/tutorials/testing-library-with-visual-studio-code.md docs/core/tutorials/testing-library-with-visual-studio-code
docs/core/tutorials/testing-library-with-visual-studio.md Tutorial: Test a .NET class library with .NET using Visual Studio
docs/core/tutorials/testing-with-cli.md Organizing and testing projects with the .NET CLI

@meaghanlewis meaghanlewis marked this pull request as ready for review October 24, 2025 16:49
@meaghanlewis meaghanlewis requested a review from a team as a code owner October 24, 2025 16:49
@Copilot Copilot AI review requested due to automatic review settings October 24, 2025 16:49
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 standardizes and modernizes documentation across .NET tutorial files. The changes update metadata to reflect AI assistance, improve prerequisite formatting, refine instructional language for clarity, and modernize code examples to use current C# syntax.

Key changes include:

  • Standardization of metadata with updated dates and AI usage attribution
  • Prerequisite section formatting improvements for better readability
  • Simplification of instructional language throughout tutorials

Reviewed Changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
cli-templates-create-item-template.md Updated metadata, improved prerequisites formatting, refined instructional language, and standardized step numbering
cli-templates-create-project-template.md Added AI usage metadata, reformatted prerequisites, and simplified instructional phrases
cli-templates-create-template-package.md Updated dates and AI attribution, improved prerequisites formatting, and refined step numbering
creating-app-with-plugin-support.md Modernized code with C# features like pattern matching and simplified path construction
debugging-with-visual-studio-code.md Updated metadata and reformatted prerequisites section
debugging-with-visual-studio.md Added AI usage metadata and improved prerequisites formatting
index.md Updated date metadata and added AI usage attribution
libraries.md Added AI usage metadata and improved sentence clarity
library-with-visual-studio.md Updated metadata and refined instructional language
netcore-hosting.md Added AI usage metadata and simplified prerequisite language
publishing-with-visual-studio.md Updated metadata and reformatted prerequisites section
testing-library-with-visual-studio-code.md Added AI usage metadata and improved prerequisites formatting
testing-library-with-visual-studio.md Comprehensive updates including metadata, prerequisites, grammar improvements, and language simplification
testing-with-cli.md Updated metadata and improved grammar in hypothetical scenario
StringLibraryTestNet8/UnitTest1.cs Modernized C# syntax with collection expressions, string interpolation, and removed file-scoped namespace braces
StringLibraryTest/UnitTest1.cs Modernized C# syntax with collection expressions, string interpolation, and removed file-scoped namespace braces
StringLibrary/Class1.cs Simplified code by removing unnecessary variable and namespace braces

Copy link
Member

@BillWagner BillWagner left a comment

Choose a reason for hiding this comment

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

This LGTM @meaghanlewis

I had one small suggestion, and noted that a number of Copilot's comments seem incorrect.

@meaghanlewis meaghanlewis merged commit 1b72982 into main Oct 24, 2025
10 checks passed
@meaghanlewis meaghanlewis deleted the freshness-dotnet-tutorials branch October 24, 2025 21:56
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.

Freshness: .NET tutorials

2 participants