Skip to content

Conversation

rcj1
Copy link

@rcj1 rcj1 commented Aug 29, 2025

Summary

These changes mostly affect the landing page of the diagnostics documentation.

  • Added a paragraph about profilers as well as a summary page directing people to VS and dotnet-trace.
  • Moved "writing a custom diagnostic tool" down on the page as it seems like a less common case.
  • Used more general title.
  • Removed "unit testing" from the front page as it is a different topic that is already well linked to.
  • Moved "resource monitoring" to the "metrics" section, similar to other built-in metrics.
  • Moved "collect diagnostics in containers" to the bottom of the page in the specialized diagnostics overview.

Fixes dotnet/diagnostics#3039


Internal previews

📄 File 🔗 Preview link
docs/core/diagnostics/index.md Diagnostics in .NET Core
docs/core/diagnostics/profilers.md Profiling tools - .NET Core
docs/core/diagnostics/specialized-diagnostics-overview.md Specialized diagnostics
docs/navigate/tools-diagnostics/index.yml [linkListType: architecture
docs/navigate/tools-diagnostics/toc.yml docs/navigate/tools-diagnostics/toc

@rcj1 rcj1 requested review from tommcdon and a team as code owners August 29, 2025 18:19
@dotnetrepoman dotnetrepoman bot added this to the August 2025 milestone Aug 29, 2025
@rcj1 rcj1 changed the title Update docs Update docs (landing page etc) Aug 29, 2025
@rcj1 rcj1 requested a review from noahfalk August 29, 2025 18:20
Copy link
Member

@noahfalk noahfalk left a comment

Choose a reason for hiding this comment

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

This looks good to me! I imagine the docs crew will want to take a look as well.


Profilers allow you to analyze your program's performance. By analyzing data on memory usage, CPU usage, call stacks and other information, you can better understand the performance profile of your program.

Microsoft provides a profiler with Visual Studio as well as through the ```dotnet-trace``` tool.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Microsoft provides a profiler with Visual Studio as well as through the ```dotnet-trace``` tool.
Microsoft provides a profiler with [Visual Studio](/visualstudio/profiling/beginners-guide-to-performance-profiling) as well as through the [dotnet-trace](dotnet-trace.md) tool.


## Visual Studio profiler

**Visual Studio** is an integrated development environment and an excellent choice for developers working on Windows. There are several tools, guides and tutorials for Visual Studio profiling listed below.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
**Visual Studio** is an integrated development environment and an excellent choice for developers working on Windows. There are several tools, guides and tutorials for Visual Studio profiling listed below.
**Visual Studio** is an integrated development environment and an excellent choice for developers working on Windows.

It appears there is only one tutorial listed below, which is just fine 👍

@noahfalk
Copy link
Member

noahfalk commented Aug 29, 2025

Demoted "resource monitoring" to "metrics" from the top-line index as it is largely deprecated.

Resource Monitoring as a whole is not deprecated. The only part that is deprecated is the particular IResourceMonitor API. Moving it off the main page was just intended to bucket it with other Metrics related information. We don't give any other built-in metrics dedicated space on the overview page so I don't think there is reason to give resource monitoring metrics extra focus.

I went ahead and edited the PR description to avoid causing confusion about the state of the resource monitoring feature.

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.

Landing page improvements
2 participants