KhronosGroup / KhronosGroup/Vulkan-Site

Evaluate cross module linkage

Open
#28 5 comments 0 reactions 0 assignees View on GitHub
component enhancement navigation process
Dominant language
JavaScript
Stars
46
Forks
10
Avg merge
12d 2h
Merged PRs (30d)
6

Description

As per mail discussion, it would be great if we somehow could get cross module linkage instead of external linkage. One sample is the guide that has links to the Vulkan samples. But that links point to the github repository instead of the Antora module. So when you click such a link from the docs site you jump to github instead of the samples Antora module. Same for the spec/registry links.

Contributor guide

Open the contributing guide

Research direction

Review the guide links to the Vulkan samples and the spec/registry links in the integrated Antora documentation site. Determine how cross-module links are represented, then verify that those links open the corresponding Antora modules instead of the GitHub repository.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.