Add conceptual documentation for new .NET Extensions packages#49372
Add conceptual documentation for new .NET Extensions packages#49372
Conversation
There was a problem hiding this comment.
Hey @copilot - This looks good so far, but I'm seeing the IAsyncState<T> doesn't exist. Instead it's simply IAsyncState, please see my ssuggestions.
|
@copilot please address my feedback |
Fixed in commit 4c82751. Updated all references from |
|
Separate the code samples that are inline in the markdown files into compiled projects. See this section of the copilot instructions for details. |
This set of review comments has been addressed
…ode comments, and :::code paths Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR adds new conceptual documentation pages for recently introduced .NET Extensions packages and wires them into the .NET fundamentals table of contents, along with compiled snippet projects for some of the new articles.
Changes:
- Adds new conceptual articles for AsyncState, DI auto-activation, TimeProvider testing (FakeTimeProvider), and AuditReports.
- Updates
docs/fundamentals/toc.ymlto include the new Extensions content. - Adds new snippet projects under
docs/core/extensions/snippets/...to support the new docs.
Reviewed changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 16 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/fundamentals/toc.yml | Adds TOC entries for the new Extensions articles. |
| docs/core/extensions/timeprovider-testing.md | New conceptual article for Microsoft.Extensions.TimeProvider.Testing and FakeTimeProvider. |
| docs/core/extensions/audit-reports.md | New conceptual article for Microsoft.Extensions.AuditReports and MSBuild report generation. |
| docs/core/extensions/async-state.md | New conceptual article for Microsoft.Extensions.AsyncState. |
| docs/core/extensions/dependency-injection/auto-activation.md | New conceptual article for Microsoft.Extensions.DependencyInjection.AutoActivation. |
| docs/core/extensions/file-globbing.md | Minor formatting/link update for the FileSystemGlobbing package reference. |
| docs/core/extensions/snippets/dependency-injection-auto-activation/** | New compiled snippet projects for auto-activation examples. |
| docs/core/extensions/snippets/async-state/** | New compiled snippet projects for async state examples. |
...s/dependency-injection-auto-activation/csharp/DependenciesExample/DependenciesExample.csproj
Show resolved
Hide resolved
.../snippets/dependency-injection-auto-activation/csharp/CompleteExample/CompleteExample.csproj
Show resolved
Hide resolved
...core/extensions/snippets/async-state/csharp/IAsyncContextExample/IAsyncContextExample.csproj
Show resolved
Hide resolved
docs/core/extensions/snippets/async-state/csharp/RequestCorrelation/RequestCorrelation.csproj
Show resolved
Hide resolved
...re/extensions/snippets/async-state/csharp/AspNetCoreIntegration/AspNetCoreIntegration.csproj
Show resolved
Hide resolved
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
BillWagner
left a comment
There was a problem hiding this comment.
This is great. I had a number of comments around the code. Most of them are to use primary constructors: Many of these types are the primary use case for primary ctors: A type that requires one or more dependencies as part of its initialization.
Also, many of the same project files use .NET 9 instead of .NET 10 (which all the code uses). That should be consistent.
Once you've looked at the comments, ![]()
Co-authored-by: Bill Wagner <wiwagn@microsoft.com>
…otnet/docs into copilot/add-docs-for-dotnet-extensions
Summary
All review feedback addressed. All package versions updated to 10.0.0. Documentation style improved per Microsoft style guide.
Original prompt
This section details on the original issue you should resolve
<issue_title>[Epic] Docs for new .NET Extensions</issue_title>
<issue_description>The following issue serves as an Epic, capturing task (issues) for individual work, such as but not limited to, conceptualizing and reasoning about various aspects of programming for .NET with numerous NuGet packages. Each package extends workload-agnostic cloud-native primitives, and fundamental building blocks for creating resilient, diagnostic-empowered, and robust features like health-checks and dependency injection (DI) auto-activation.
Each conceptual article with be interleaved into an appropriate section (or sub-section) of the existing .NET libraries content.
.NET Extensions:
Microsoft.Extensions.Http.AutoClientMicrosoft.Extensions.ResilienceMicrosoft.Extensions.Http.ResilienceMicrosoft.Extensions.Diagnostics.ProbesMicrosoft.Extensions.Diagnostics.ResourceMonitoringMicrosoft.Extensions.Diagnostics.ExceptionSummarizationMicrosoft.Extensions.Diagnostics.HealthChecks.CommonMicrosoft.Extensions.Diagnostics.HealthChecks.ResourceUtilizationMicrosoft.Extensions.DependencyInjection.AutoActivationMicrosoft.Extensions.AsyncStateMicrosoft.Extensions.AmbientMetadata.ApplicationMicrosoft.Extensions.TimeProvider.TestingMicrosoft.Extensions.AuditReportsASP.NET Core:
I'm going to tag @Rick-Anderson here, who from the ASP.NET Docs team can write a new conceptual article for the following NuGet package?
Microsoft.AspNetCore.HeaderParsing</issue_description><agent_instructions>Please continue work on this issue, the task list has links to NuGet packages that need to have corresponding conceptual content. Please start creating new articles next to the existing ones under .NET Fundamentals / Extensions. These packages are a result of the: https://github.com/dotnet/extensions repo. Use that as a source of truth.</agent_instructions>
Comments on the Issue (you are @copilot in this section)
Fixes #37411
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.
Internal previews