KhronosGroup / KhronosGroup/Vulkan-Site

Going through all instances of X

Open
#55 3 comments 0 reactions 0 assignees View on GitHub
antora feature request search
Dominant language
JavaScript
Stars
46
Forks
10
Avg merge
12d 2h
Merged PRs (30d)
6

Description

Moving this issue over from the archived Antora repo (https://gitlab.khronos.org/vulkan/antora/-/issues/5 from @ShabbyX). Note: there are some comments on the archived repo on this issue..

The all-in-one-page spec is horribly slow to load, but it does give one ability that the chunked spec (or the antora version) doesn't. You can go through all instances of some token over the whole spec.
With GL, extensions were easy to inspect in one aspect at least; you had the text of the whole extension all together somewhere. Someone implementing / using the extension could get all the details that are needed from that.
With Vulkan, that's nearly impossible without grepping through the source. The ifdefs (which are the only mark of what text an extension affects) disappear from the output, so you can't really tell from the built spec where exactly an extension touches. That makes it easy to miss things. That said, at least going through the whole spec and looking at matches of someTokenFromExtension would get you 95% of the way.
I'm not sure what a good way would be to do that in a chunked build, but something like this could work:

________________________ ____
| someTokenFromExtension | ◀ Match | 12 | / 67 ▶
------------------------ ----

Where you can enter someTokenFromExtension in the search box (that's the ASCII art box), and get a chance to flip through all the matches one by one (with the left/right triangle buttons) (or jump to a match (by editing the match number, the other ASCII art box))

Contributor guide

Open the contributing guide

Research direction

The issue names no files or tests. Start by examining how the chunked specification is built and how its search and navigation work. Done means a token can be searched across the generated specification, with controls to move through matches and jump to a selected match, including extension-related occurrences.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation, frontend, search
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.