search

microsoft / microsoft-ui-xaml

WinUI: a modern UI framework with a rich set of controls and styles to build dynamic and high-performing Windows applications.
MIT License
6.38k stars 683 forks source link

Proposal: Documentation xref file for WinUI 3 / WinAppSDK #10132

Open mikernet opened 3 weeks ago

mikernet commented 3 weeks ago

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

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.

dotMorten commented 3 weeks ago

I'd really like to see this as well, since our API reference isn't able to resolve WinUI types either, and it's an annoying inconsistency in our documentation.