1// Copyright 2022-2023 The Khronos Group Inc. 2// SPDX-License-Identifier: CC-BY-4.0 3 4= Vulkan Documentation 5 6include::{config}/attribs.adoc[] 7include::{generated}/specattribs.adoc[] 8 9== About 10 11link:https://docs.vulkan.org/[This site] gathers together several key 12Vulkan documents including specifications, guides, tutorials and samples 13into a single site allowing for easy cross-searching and cross-linking 14across documents to help navigate quickly to the information you need 15for developing Vulkan-based applications. 16 17For more details about and resources for using the Vulkan graphics API, 18see the Vulkan developer website at https://vulkan.org . 19 20This build of the site includes the Vulkan {SPECREVISION} API specification 21{APITITLE}, generated on {SPECDATE} {SPECREMARK}. 22 23== Navigation 24 25The left sidebar links to pages in the current spec. 26Proposals are available at the bottom of the sidebar links for the spec. 27 28The right sidebar is sections within the current page. 29 30The bottom-left button switches between the various documentation modules and specs. 31 32The top contains a text searchbar. 33It will suggest matches to search terms found in all the modules of the 34site. 35 36== Site Information 37 38link:https://docs.vulkan.org/[This site] is generated using the 39link:https://docs.antora.org/[Antora] static site generator. 40 41If you need to report a problem or build the site yourself, start with 42the 43link:https://github.com/KhronosGroup/Vulkan-Site/[Vulkan-Site] 44repository on GitHub. 45