Samples documentation fixes and enhanchements #905
Conversation
List of examples in subfolder readme This is then included in tioplevel sample listing instead Paths need to be adjusted via attributes to make it work for both
Makes xrefs works both on the separate sample list as well as the page including it Refs #898
Include in main listing
Include in main listing
Include in main listing
Didn't work in github either, and makes no sense People will see that template when they actually do a PR against the repo
Fix linkage for framework core
Refs #824
PRs are created via github anyway, and this automatically uses the PR template No need to mention it explicitly
There was a problem hiding this comment.
Mega! Thanks @SaschaWillems for putting in the graft on this one
Is there a quick script we could right to make sure all the links work? Looks like all the paths are relative so we could make a small CI task to make life easier in the future?
Happy to help here
|
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 😃 |
# Conflicts: # antora/modules/ROOT/nav.adoc # samples/README.adoc
|
@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. |
* Include related extension list instead of linking to it (link was broken anyway) * Different content depending on generator * Reworking things List of examples in subfolder readme This is then included in tioplevel sample listing instead Paths need to be adjusted via attributes to make it work for both * Fix links to ray tracing samples KhronosGroup#903 * Fix xref paths Makes xrefs works both on the separate sample list as well as the page including it Refs KhronosGroup#898 * Fix links to ray tracing samples Refs KhronosGroup#903 * Add samples listing to docs navigation * Move api samples listing into separate readme Include in main listing * Added readme for general samples folder Include in main listing * Add samples listing to docs navigation * Move tooling and performance samples listing into separate readme Include in main listing * Update pull request template * Remove link to pull request template Didn't work in github either, and makes no sense People will see that template when they actually do a PR against the repo * Add link to framework components Fix linkage for framework core * Fix link to debug utils sample * Add a stub readme for the docs folder * Fix broken links Refs KhronosGroup#824 * Fix broken image links Refs KhronosGroup#824 * Removed unnecessary paragraph PRs are created via github anyway, and this automatically uses the PR template No need to mention it explicitly * Fix copyright * Fix copyright (again...) * Fix typo
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: