Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Open
mikernet opened this issue Nov 2, 2024 · 1 comment
Open

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

mikernet opened this issue Nov 2, 2024 · 1 comment
Labels
documentation An issue with existing documentation or a request for documenation of a new topic feature proposal New feature proposal product-winui3 WinUI 3 issues

Comments

@mikernet
Copy link

mikernet commented Nov 2, 2024 •
edited
Loading

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.
@mikernet mikernet added the feature proposal New feature proposal label Nov 2, 2024
@microsoft-github-policy-service microsoft-github-policy-service bot added the needs-triage Issue needs to be triaged by the area owners label Nov 2, 2024
@mikernet mikernet changed the title Proposal: Documentation xref service for WinUI 3 / WinAppSDK Proposal: Documentation xref file for WinUI 3 / WinAppSDK Nov 2, 2024
@mikernet mikernet mentioned this issue Nov 4, 2024
Closed
@dotMorten
Copy link
Contributor

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.

@karkarl karkarl added documentation An issue with existing documentation or a request for documenation of a new topic product-winui3 WinUI 3 issues and removed needs-triage Issue needs to be triaged by the area owners labels Nov 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation An issue with existing documentation or a request for documenation of a new topic feature proposal New feature proposal product-winui3 WinUI 3 issues
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@dotMorten @mikernet @karkarl