KhronosGroup / Vulkan-Site

Vulkan Documentation Project framework for integrated documentation site with spec, proposals, guide, and more
Other
25 stars 2 forks source link

[FEATURE] Fold the valid usage sections by default #94

Closed goeiecool9999 closed 1 hour ago

goeiecool9999 commented 1 hour ago

The valid usage sections take up a lot of space in the documentation. This hinders navigation and reading. To illustrate this point there are two images below. I have highlighted parts of the text where the spec references itself. The first image shows how far you have to scroll to get between the parts of the text. The second image shows a mock-up where I cut out the valid usage sections and added a little plus symbol that would function as a button to toggle the folding. If GitHub's preview formatting matches the final publication (and if your monitor's scaling matches mine) it should be easy to compare.

Personally I find that having that information hidden makes it a lot easier to keep track of where I am in the document and improves my reading flow. The valid usage rules are really only relevant when you are interested in a specific part because you're about to use it for example. But if you're only reading the specification to learn about the API or are trying to find a specific section, it becomes tiresome to keep skipping over the valid usage sections. Maybe it should be a user setting so people who are new to the spec don't overlook it altogether?

Current website

image

Suggestion mock-up

image

goeiecool9999 commented 1 hour ago

Apologies! I have just realised this is a duplicate of #22.