KhronosGroup / Vulkan-Samples

One stop solution for all Vulkan samples
Apache License 2.0
4.21k stars 633 forks source link

Tracking issues for samples without tutorials/documentation #729

Closed SaschaWillems closed 4 months ago

SaschaWillems commented 1 year ago

Esp. older samples don't have proper tutorials/documentation and only contain a readme stub.

Since we want to make the documentation of this repo part of the broader Vulkan docs, we should add proper tutorials/documentation for all samples.

This is a tracker issue for that, here is the list of tutorials that don't have a proper tutorial/readme:

This is related to https://github.com/KhronosGroup/Vulkan-Samples/issues/693

tomadamatkinson commented 1 year ago

We may want to comment up the hello triangle code base with links to the Vulkan Tutorial documentation. It may make it easier if a reader can jump from function X to a specific part of the documentation

SaschaWillems commented 4 months ago

We agreed that this has very little priority, esp. when compared to the effort, so closing this.