KhronosGroup / KhronosGroup/Vulkan-Docs
Link to parameter types from [source] blocks
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 3.3k
- Forks
- 549
- Avg merge
- 5d 5h
- Merged PRs (30d)
- 2
Description
When looking at the reference page for a command I find myself often looking at the page for one of the parameter structs next. For example I was just looking at vkCreatePipelineCache and next wanted to see members of VkPipelineCacheCreateInfo.
Of course the link is down in the "See Also" section, but from a convenience point of view it would be nice if the parameter types in the "Parameters" section could be turned into links. Thanks!
This is loosely related to issue #608.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the linked vkCreatePipelineCache reference page's Parameters and See Also sections, then trace how those sections are generated in Vulkan-Docs. Identify where parameter types such as VkPipelineCacheCreateInfo are rendered and verify that the resulting parameter names link to their reference pages without changing unrelated links.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100