1// Copyright 2017-2023 The Khronos Group Inc.
2// SPDX-License-Identifier: CC-BY-4.0
3
4ifdef::env-github[]
5:note-caption: :information_source:
6endif::[]
7
8= Vulkan^(R)^ SC API Documentation Project
9
10The link:https://github.com/KhronosGroup/VulkanSC-Docs[VulkanSC-Docs]
11repository (or the equivalent internal Khronos tracking repository)
12contains sources for the formal documentation of the Vulkan SC
13API. This includes:
14
15[options="compact"]
16  * The Vulkan SC API Specification
17  * Specification of API extensions
18  * API reference ("`man`") pages
19  * The XML API Registry (also mirrored at
20    link:https://github.com/KhronosGroup/Vulkan-Headers[Vulkan-Headers] under the `sc_main` branch)
21  * Vulkan SC header files (also mirrored at
22    link:https://github.com/KhronosGroup/Vulkan-Headers[Vulkan-Headers] under the `sc_main` branch)
23  * Related tools and scripts.
24
25The authoritative public repository is located at
26link:https://github.com/KhronosGroup/VulkanSC-Docs[VulkanSC-Docs].
27It hosts a public Issue tracker, and outside developers can file proposed
28changes (Pull Requests) against the Specification, subject to approval by
29Khronos.
30
31Questions and feedback on the Vulkan SC specification can be made using the GitHub
32link:https://github.com/KhronosGroup/VulkanSC-Docs/issues/[Issues]
33and
34link:https://github.com/KhronosGroup/VulkanSC-Docs/discussions[Discussions]
35features on the
36link:https://github.com/KhronosGroup/VulkanSC-Docs/[VulkanSC-Docs]
37repository.
38
39For standard Vulkan (not Vulkan SC) related issues, consult the
40link:https://github.com/KhronosGroup/Vulkan-Web-Registry/blob/main/Vulkan-Projects.adoc[Vulkan-Projects] list on the link:https://github.com/KhronosGroup/Vulkan-Web-Registry[Vulkan-Web-Registry]
41repository.
42
43== External Contributions
44
45Khronos welcomes feedback in GitHub Issues, and proposed changes in GitHub
46Pull Requests (PRs), but will not necessarily accept all such changes.
47
48Please keep your issues and pull requests focused on solving a single
49problem. Broader feedback that tries to solve multiple problems, or touches
50many parts of the Specification at once, is difficult for the Vulkan SC Working
51Group to review in a timely fashion.
52
53
54== Branch Structure
55
56The current Specification is maintained in the default branch (currently
57`sc_main`) of the repository.
58From this branch it is possible to generate Specifications for any published
59version of Vulkan SC, and incorporating any desired set of extensions.
60Each published update is tagged in the form `vksc1.0.*release*` where *release*
61is a constantly incrementing release number and `1.0` is the latest
62published version of the API.
63
64
65