microsoft / microsoft/microsoft-ui-xaml

Proposal: Documentation xref file for WinUI 3 / WinAppSDK

Open
#10,132 1 comment 1 reaction 0 assignees View on GitHub
documentation feature proposal product-winui3
Dominant language
C++
Stars
8.4k
Forks
942
Avg merge
2d 7h
Merged PRs (30d)
105

Description

# Proposal: Documentation xref file for WinUI 3 / WinAppSDK

## Summary

There does not appear to be a WinUI 3 xref service or xref map json file that can be used for documentation (or at least I can't find it), which means references to any of those types can't be cross-linked with MS docs and their full type names get output by `docfx` instead of more succinct clickable links:

![Image](https://github.com/user-attachments/assets/1b596de4-932d-4631-98fc-5a1baa5e3f9d)

This is the only time I have run into this. Even the community toolkit has proper xrefs. The community toolkit's docs on learn.ms.com also don't cross-link correctly with WinAppSDK so it seems that this is indeed an issue.

Contributor guide

Open the contributing guide

Research direction

No file or test is named. Start by investigating how the documentation build invokes docfx and whether an existing xref map or service configuration is present. Compare the WinUI 3/WinAppSDK references with the Community Toolkit example mentioned in the issue; done means those references produce succinct clickable links.

Written by the indexing model from the issue text.

Assessment

Domain
desktop, documentation
Issue type
Documentation
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.