-
Notifications
You must be signed in to change notification settings - Fork 477
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor 'proposals' into a separate Antora component 'features' (#2361)
* Refactor 'proposals' into a separate Antora component 'features' and refer to them as 'Feature Description's where possible. See KhronosGroup/Vulkan-Site#54 * Use correct start page for features component and fix some cross-module xrefs
- Loading branch information
Showing
14 changed files
with
175 additions
and
171 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Copyright 2024 The Khronos Group Inc. | ||
# SPDX-License-Identifier: Apache-2.0 | ||
|
||
**/images | ||
**/chapters | ||
**/appendices | ||
**/partials | ||
**/pages/proposals |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Copyright 2022-2024 The Khronos Group Inc. | ||
# SPDX-License-Identifier: Apache-2.0 | ||
|
||
name: features | ||
title: Vulkan Feature Descriptions | ||
version: latest | ||
start_page: features:index.adoc | ||
# stem (latexmath) support is provided by the @djencks/asciidoctor-mathjax | ||
# extension, loaded in the playbook. | ||
asciidoc: | ||
attributes: | ||
stem: latexmath | ||
config: partial$config | ||
chapters: partial$chapters | ||
appendices: partial$appendices | ||
generated: partial$gen | ||
images: image$ | ||
# Not supported for SVG yet - see https://gitlab.com/antora/antora/-/issues/1001 | ||
# imageopts: inline | ||
imageopts: '' | ||
refprefix: '' | ||
nav: | ||
- modules/features/nav.adoc |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
// Copyright 2022-2024 The Khronos Group Inc. | ||
// SPDX-License-Identifier: CC-BY-4.0 | ||
|
||
= Vulkan Feature Descriptions | ||
|
||
This component includes all published extension feature descriptions, as | ||
well as the original rationale for the xref:proposals/Roadmap.adoc[Vulkan | ||
Roadmap] process which resulted in the | ||
xref:spec::appendices/roadmap.adoc[Roadmap 2022 and Roadmap 2024] milestones. | ||
|
||
When a Vulkan extension begins development, a "`proposal`" document is | ||
written outlining the proposed API. | ||
The proposal is the basis from which specification language is written. | ||
|
||
When the extension is published, the proposal - now referred to as a | ||
"`feature description`" - is retained to act as supplementary documentation | ||
on that extension. |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
// Copyright 2022-2024 The Khronos Group Inc. | ||
// SPDX-License-Identifier: CC-BY-4.0 | ||
|
||
= Vulkan Documentation | ||
|
||
include::{config}/attribs.adoc[] | ||
include::{generated}/specattribs.adoc[] | ||
|
||
|
||
== About | ||
|
||
link:https://docs.vulkan.org/[This site] gathers together several key Vulkan | ||
documents including specifications, extension proposals, guides, tutorials | ||
and samples into a single site. | ||
This allows searching and cross-linking across documents, to help navigate | ||
quickly to the information you need for developing Vulkan-based | ||
applications. | ||
|
||
For more information about and resources for using the Vulkan graphics API, | ||
see the Vulkan developer website at https://vulkan.org . | ||
|
||
This build of the site includes the Vulkan {SPECREVISION} API specification | ||
{APITITLE}, generated on {SPECDATE} {SPECREMARK}. | ||
|
||
|
||
== Navigation | ||
|
||
The site is organized in "`components`" (Antora terminology for | ||
specifications and other documents), each containing many "`pages`" (Antora | ||
terminology for a chapter of a specification, or other distinct piece of | ||
content for other components). | ||
|
||
The left navigation sidebar links to pages in the current component. | ||
|
||
The right navigation sidebar links to sections in the current page. | ||
|
||
The bottom-left button switches between components. | ||
|
||
The top navigation bar contains a text searchbox. | ||
If the "`In this component`" box is checked, search will be restricted to | ||
the current component. | ||
Otherwise, all components of the site are searched. | ||
|
||
|
||
== Site Information | ||
|
||
link:https://docs.vulkan.org/[This site] is generated using the | ||
link:https://docs.antora.org/[Antora] static site generator. | ||
|
||
If you need to report a problem or build the site yourself, start with the | ||
link:https://github.com/KhronosGroup/Vulkan-Site/[Vulkan-Site] repository on | ||
GitHub. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.