Vulkan-docs is the official API specification and documentation repository for the Vulkan graphics and compute API maintained by the Khronos Group.
The repository serves as the authoritative source for the Vulkan API specification and reference documentation. It addresses the need for comprehensive, standardized documentation of the Vulkan API by maintaining specification documents in Asciidoctor format and generating API headers and related files from a centralized XML registry. The approach separates specification markup from generated artifacts, allowing the XML registry to serve as the single source of truth from which C headers and documentation components are automatically produced.
Developers working on Vulkan implementations, bindings, or applications that need to reference the official specification should use this repository. It is essential for anyone implementing Vulkan drivers, creating language bindings, or contributing to the Vulkan ecosystem. The repository includes separate documentation tracks for both the standard Vulkan API and Vulkan SC, a safety-critical variant designed for use in safety-critical systems.
The project maintains active development with regular updates to the specification and toolchain. The build system uses Asciidoctor and related tools to generate output documents from source markup, with a Makefile-based workflow for managing dependencies and regenerating headers from the XML registry. Changes to the XML registry automatically trigger regeneration of C headers and related specification components through the build system's dependency tracking.
