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)^ API Documentation Project
9
10The link:https://github.com/KhronosGroup/Vulkan-Docs[Vulkan-Docs]
11repository (or the equivalent internal Khronos tracking repository)
12contains sources for the formal documentation of the Vulkan
13API. This includes:
14
15[options="compact"]
16  * The Vulkan 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])
21  * Vulkan header files (also mirrored at
22    link:https://github.com/KhronosGroup/Vulkan-Headers[Vulkan-Headers])
23  * Related tools and scripts.
24
25The authoritative public repository is located at
26link:https://github.com/KhronosGroup/Vulkan-Docs/[Vulkan-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
31If in doubt where to submit your Issue, consult the
32link: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]
33repository.
34
35The Vulkan-Docs repository also includes the sources for the Vulkan SC
36specification in order to simplify the long-term maintenance of the Vulkan SC
37specification. These are not considered normative. The formal sources for
38Vulkan SC can be found as detailed in link:READMESC.adoc[READMESC.adoc]
39
40== External Contributions
41
42Khronos welcomes feedback in GitHub Issues, and proposed changes in GitHub
43Pull Requests (PRs), but will not necessarily accept all such changes.
44
45Please keep your issues and pull requests focused on solving a single
46problem. Broader feedback that tries to solve multiple problems, or touches
47many parts of the Specification at once, is difficult for the Vulkan Working
48Group to review in a timely fashion.
49
50
51== Branch Structure
52
53The current Specification is maintained in the default branch (currently
54`main`) of the repository.
55From this branch it is possible to generate Specifications for any published
56version of Vulkan (1.3, 1.2, 1.1, and 1.0), and incorporating any desired set of
57extensions.
58Each published update is tagged in the form `1.3.*release*` where *release*
59is a constantly incrementing release number and `1.3` is the latest
60published version of the API.
61The last public spec update prior to Vulkan 1.3 is tagged `v1.2.???`.
62
63The last state of the default branch in Khronos' internal GitLab server,
64before 1.3 content was merged into it, is tagged `1.2-archive` (this tag is
65not in GitHub).
66
67
68