Closed SaschaWillems closed 8 months ago
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.
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 😃
@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.
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:
Enhanchements:
Fixes #903 Fixes #898 Fixes #824 Fixes #801
Note: This is a pure documentation fix
General Checklist:
Please ensure the following points are checked: