Add note about documentation site, remove note on renaming master to … - Githubissues

KhronosGroup / Vulkan-Samples

One stop solution for all Vulkan samples

Apache License 2.0

4.23k stars 634 forks source link

Add note about documentation site, remove note on renaming master to … #1111

Closed SaschaWillems closed 2 months ago

SaschaWillems commented 2 months ago

Description

This PR makes some minor changes to the sample's main readme:

It adds a note that the documentation is best viewed through docs.vulkan.org (see #1018). This note is only visible here on github, it's hidden when viewing the docs through Antora.
It removes the note that we renamed the master branch to main. This has been there for ages and by now every contributor should've switched over to main.

Note: 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
If this PR contains framework changes:
- [ ] I did a full batch run using the batch command line argument to make sure all samples still work properly