Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add link to OpenCL ARM sample to Antora navigation, update templates #822

Merged

Conversation

SaschaWillems
Copy link
Collaborator

Description

This PR adds the vendor-specific OpenCL ARM sample to the navigation for the Antora site so that it's documentation can be accessed from the docs site.

The PR also slightly adds a new entry to the the pull request template checklist for new samples:

For new samples, I have added a link to the Antora navigation so that the sample will be listed at the Vulkan documentation site

This is a pure documentation fix

General Checklist:

Please ensure the following points are checked:

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

Note: The Samples CI runs a number of checks including:

  • I have updated the header Copyright to reflect the current year (CI build will fail if Copyright is out of date)
  • My changes build on Windows, Linux, macOS and Android. Otherwise I have documented any exceptions

Updated pull request and sample readme template with note about adding links to the Antora navigation for new samples
@SaschaWillems SaschaWillems added the documentation Improvements or additions to documentation label Oct 7, 2023
@marty-johnson59 marty-johnson59 merged commit dcaa8ec into KhronosGroup:main Oct 9, 2023
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants