godotengine / godot-docs

Godot Engine official documentation
https://docs.godotengine.org
Other
3.81k stars 3.09k forks source link

Suggest Visual Studio as a C# profiler alternative #9999

Open renanliberato opened 3 days ago

renanliberato commented 3 days ago

Your Godot version: 4.3 .NET

Issue description: I used this Reddit comment (link) to setup Visual Studio Community as a C# profiler to get Memory Snapshots to find a memory leak and it worked like a charm! Even though the setup is not automatic, it took <5 min. I think it should be also suggested as a free alternative to Jetbrains Rider / DotTrace in the Profiler documentation.

Currently, what's in the documentation is this: Screenshot_20240925_094336_Chrome

As the setup requires some manual steps, I volunteer to write a section based on the Reddit comment guiding the user to setup it.

URL to the documentation page (if already existing): https://docs.godotengine.org/en/stable/tutorials/scripting/debug/the_profiler.html

tetrapod00 commented 3 days ago

(I'm just a contributor, I don't speak for maintainers)

FYI for docs changes, there's not quite the same long proposal->approval->PR->review process that there is for main repo feature additions.

For small docs changes you can just go ahead and make a PR.

For medium changes like this, if no one explicitly gives you the go-ahead in this thread, try discussing in the https://chat.godotengine.org/channel/documentation (or in this case https://chat.godotengine.org/channel/dotnet) channels of the contributors chat. And if you don't mind potentially wasting work, you could just make the PR and let discussion happen in the PR review.


In this specific case, I don't think we want to be adding a long section to this page about using external profiling tools. Adding another external program to the short note seems fine, but if you have a longer section to write it should probably be somewhere in the C# section, but I don't know where.

tetrapod00 commented 3 days ago

We already have this section Profiling your C# code. So any longer section could go there, maybe. And the note on the Profiler should probably cross-link to the C# profiling section. (But it doesn't currently cross-link, because the section it would be linking to is so short it provides almost no extra information)

renanliberato commented 2 days ago

Alright!! Thanks for the tips. I'll try to get some spare time this week and try the PR approach 🙇