search

dotnet / runtime

.NET is a cross-platform runtime for cloud, mobile, desktop, and IoT apps.
https://docs.microsoft.com/dotnet/core/
MIT License
14.98k stars 4.66k forks source link

System.Diagnostics.TraceSource: Backport MS Docs documentation to triple slash #48942

Closed carlossanlop closed 2 years ago

carlossanlop commented 3 years ago

We are working on a new documentation process plan, in which the main objective is to make triple slash comments the source of truth for documentation, instead of MS Docs: We want developers/maintainers to have an easier time maintaining the documentation for their APIs.

You can use the DocsPortingTool to automate the backport process: Run the tool targeting the assembly, then submit a PR with the changes.

You can find detailed instructions for the backporting process here.

Area owners are free to decide if they want to address this in 6.0 or in Future.

jeffhandley commented 2 years ago

We are closing all of the issues for backporting api docs to triple-slash comments for now. We concluded early in the .NET 7.0 release cycle that we need to invest more into the DocsPortingTool to set this effort up for success. When we're able to revisit this, we will open new issues per area again.