search

KhronosGroup / Vulkan-Samples

One stop solution for all Vulkan samples
Apache License 2.0
4.33k stars 648 forks source link

Link in Command buffers usage readme broken #1018

Closed wasimabbas-arm closed 3 months ago

wasimabbas-arm commented 7 months ago

In the further reading section of https://github.com/KhronosGroup/Vulkan-Samples/blob/main/samples/performance/command_buffer_usage/README.adoc

Screenshot 2024-04-11 at 09 37 30

The Multi-threaded recording with multiple render passes is using this xref markdown autolink,

* xref:samples/performance/multithreading_render_passes/README.adoc[Multi-threaded recording with multiple render passes]

which is pointing at https://github.com/KhronosGroup/Vulkan-Samples/blob/main/samples/performance/command_buffer_usage/samples/performance/multithreading_render_passes/README.adoc and that doesn't exist, you get a 404.

SaschaWillems commented 7 months ago

That's an unfortunate side-effect of getting thinks properly working with docs.vulkan.org. If you click the link on that site: https://docs.vulkan.org/samples/latest/samples/performance/command_buffer_usage/README.html#_further_reading it'll work properly.

Getting documentation to work both with github and antora isn't always easy but I'll try to take a look at it.

SaschaWillems commented 3 months ago

Closing this for now. There is sadly no easy fix with github's asciidoc support being kinda limited. We'll probably add a hint letting people know that the proper documentation should be viewed through docs.vulkan.org.