Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rework or elaborate development tools chapter #232

Open
SaschaWillems opened this issue Sep 19, 2023 · 4 comments
Open

Rework or elaborate development tools chapter #232

SaschaWillems opened this issue Sep 19, 2023 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@SaschaWillems
Copy link
Collaborator

The development tools chapter is a bit light on details and also kinda mixes some tools. E.g. AMD's RGP is listed as a profiler, while it an also do debugging. Vice versa nvidia's nsight is only listed as a debugger while it can also do profiling.

We should try to rework this and maybe instead of splitting between profiling/debugging tools we could just have one chapter and then write a small note on each tool. We could then also add that RenderDoc is a vendor independent debugger and kinda like the "official" debugging tool for Vulkan.

@spencer-lunarg
Copy link
Contributor

personally I always debated if this repo was the right place for the development tools chapter

It is not as much as a "living" page as I would expect and always comes down to these strange "well this tool is actually..." or "and there is also this tool..."

This page was created before the Vulkan website was re-worked and curious if things like this are better for there (or one of the various other places that try to host all these tools references)

@gpx1000
Copy link
Contributor

gpx1000 commented Sep 19, 2023

I hesitate to suggest putting those kinds of details elsewhere. We're in the process of incorporating the guide in with the new vulkan documentation project. Dev tools don't really belong with a tutorial, don't really belong with samples and don't really belong with the main website. The only real place for them is within a guide I think.
While we shouldn't "bless" any one dev tool from any one provider. We really should help the community with an idea of how to do profiling / debugging etc as that's a core part of the missing story.

@SaschaWillems
Copy link
Collaborator Author

Both point-of-views are valid :)

My take on this: Debugging and profiling tools play a big role in developer on-boarding. And that's something we want to improve. As for on-boarding I think the guide plays an important role as it fills some important gaps.

My ideal vision of this would be having a small tutorial/resource page for every Vulkan debugger/profiler ;)

@marty-johnson59
Copy link
Contributor

IMO, for now, it would be good to provide an "example" of tools that newcomers could use and point to vulkan.org for more options. This could hopefully be done fairly quickly - and we could message that this is just one of many options, so we aren't trying to "bless" anything.. Eventually, Sascha's vision would be great, but with limited resources, I'm leaning toward expedient ways to get folks up and running..

@marty-johnson59 marty-johnson59 added the documentation Improvements or additions to documentation label Jan 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants