Vulkan-Samples icon indicating copy to clipboard operation
Vulkan-Samples copied to clipboard

Samples documentation fixes and enhanchements

Open SaschaWillems opened this issue 1 year ago • 3 comments

Description

I went through all of the outstanding issues with regards to the samples documentation generated for https://docs.vulkan.org and hopefully fixed all open problems with this PR. Aside from fixing things, this PR also improves documentation in a few spots. Once merged documentation for our samples should be perfect now.

Bugfixes:

  • Fixed ~30 broken links, both to documents and images (antora build is now 100% clean for me)
  • Added in some referenced documents that were simply not present

Enhanchements:

  • Split the samples list into one file per folder (api, performance, extension, etc.), so that every sub folder in the docs site now shows the list of samples for this exact folder
  • The samples overview listing is now created by include the above files, so it looks just as a before
  • Added links to a few documents in the navigation that were there but not accessible through it yet

Fixes #903 Fixes #898 Fixes #824 Fixes #801

Note: This is a pure documentation fix

General Checklist:

Please ensure the following points are checked:

  • [x] My code follows the coding style
  • [x] I have reviewed file licenses
  • [n/a] I have commented any added functions (in line with Doxygen)
  • [n/a] I have commented any code that could be hard to understand
  • [n/a] My changes do not add any new compiler warnings
  • [n/a] My changes do not add any new validation layer errors or warnings
  • [n/a] I have used existing framework/helper functions where possible
  • [n/a] My changes do not add any regressions
  • [n/a] I have tested every sample to ensure everything runs correctly
  • [n/a] This PR describes the scope and expected impact of the changes I am making

SaschaWillems avatar Feb 10 '24 17:02 SaschaWillems

Running antora to build the docs site will output errors. If you pipe that output you get JSON that can easily be parsed. Though I'm not sure if we can do this in this repo alone, as the samples are only a part of the whole docs repo. So if at all, we should do it in the doc site repo. Though I think Jon does that anyway.

Adding it to this repo for the CI would probably make life hard for contributors, as you'd need to know how to build an antpra project and how to fix things.

SaschaWillems avatar Feb 10 '24 18:02 SaschaWillems

Makes sense, it's low priority if we did pursue it. Jsut thought we might be able to whip something up in 30 minutes which might help save yourself a bit of effort in the long run

Happy to stay as is for now 😃

tomadamatkinson avatar Feb 10 '24 20:02 tomadamatkinson

@marty-johnson59 : Would be great of we could merge this on the next samples/doc call before we merge any other new sample PRs to avoid merge conflicts.

SaschaWillems avatar Feb 23 '24 13:02 SaschaWillems