KhronosGroup / KhronosGroup/Vulkan-Docs
Overly long common prefixes and suffixes
- Dominant language
- JavaScript
- Stars
- 3.3k
- Forks
- 549
- Avg merge
- 5d 5h
- Merged PRs (30d)
- 2
Description
Pages such as https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/VkPipelineStageFlagBits2KHR.html have lines that are dominated by patterns like `static const VkPipelineStageFlags2KHR VK_PIPELINE_STAGE_2_..._BIT_KHR = ...;` which is a lot of redundant text in relation to actual content and also causes wrap-around with longer names, both of which I find to be hinderances when reading, even if minor. I don't have any good solutions of my own to propose but I'd just like to bring this maybe-issue to light.
Contributor guide
Research direction
Start with the referenced Vulkan specification page and investigate how its long constant declarations are generated or rendered. The issue names no repository files, tests, or concrete solution, so the work is not complete until a formatting approach is agreed and the resulting pages are verified to be easier to read.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100