Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tracking issue to direct VVL VUID links into docs.vulkan.org #8785

Open
oddhack opened this issue Oct 31, 2024 · 0 comments
Open

Tracking issue to direct VVL VUID links into docs.vulkan.org #8785

oddhack opened this issue Oct 31, 2024 · 0 comments
Assignees
Labels
Enhancement New feature or request

Comments

@oddhack
Copy link

oddhack commented Oct 31, 2024

With KhronosGroup/Vulkan-Docs#2453 merged, the next time we push Vulkan-Headers validusage.json will contain 'page' keys populated with the relative path to the Antora site page containing that VUID, e.g. the 'page' key for VUID-blah should be interpreted relative to https://docs.vulkan.org/spec/latest/ or wherever the corresponding site is published. This will be a much faster way to access VU statements in context, but there are several big steps remaining before we can do that:

  • Since VVL wants to refer to the build-specific specs in the SDK rather than the current specs published by the WG, that process will have to be expanded to publish the static HTML site built by Antora. One way would be to grab the complete docs.vulkan.org build from the Vulkan-Site repository CI, but then you would be publishing all the other modules (guide, tutorials, etc.) in the SDK, not just the spec. Alternatively, I am starting work on building just the spec module subset of the docs site as part of Vulkan-Docs CI, so when that's working it could be repurposed for SDK builds as well.
  • Once the site is published, the VVL itself will need to be modified to refer to that site + the 'page' key when offering an outbound VUID link.
@spencer-lunarg spencer-lunarg added the Enhancement New feature or request label Oct 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants