Track docs coverage for WinUI 3 Gallery samples
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 30/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Activo
- Stack tecnológico
- csharp
- Área
- desktop-dev, documentation
Línea de trabajo
This is a tracking issue with many separate items, so pick one small piece rather than the whole list. A good starting point is one link fix in ControlInfoData.json, such as changing the CompactSizing Docs URL to the canonical compact-sizing page, then checking that the sample still opens. The protocol-activation change in App.xaml.cs is larger and needs a maintainer's view first. Done means the chosen item is fixed and its checkbox can be ticked.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
This issue tracks gaps between the WinUI 3 Gallery samples and the conceptual docs on Microsoft Learn so we can follow up on them. I audited the Docs links of all 126 samples in ControlInfoData.json (main @ 2704168) against the current Learn docs, and checked the winui3gallery:// deep links the docs use to open samples in the gallery.
1. Samples without conceptual docs
Stable APIs
- Popup (
Popup): published Popup control guidance covers creation, positioning, dismissal, and animation. - XAML Conditions (
CustomXamlConditionals): Conditional XAML now covers implementing and usingIXamlCondition. - Badge notifications (
BadgeNotificationManager): Badge notifications now coversMicrosoft.Windows.BadgeNotifications, alongside the separate UWP guidance. - TitleBar drag regions (
TitleBar): Customize drag regions coversTitleBar.IsDragRegion,AutoRefreshDragRegions, andRecomputeDragRegions(). - SplitMenuFlyoutItem (
MenuFlyoutsample): Add a split menu item covers this control.
All five stable-docs items were delivered by MicrosoftDocs/windows-dev-docs-pr#7416, merged October 14, 2026. The published Learn pages were verified on November 8.
Experimental APIs
These APIs remain experimental. Completed items below mean conceptual guidance is published, not that the APIs have shipped in a stable release.
- TableView (2.5-experimental): TableView control, delivered by MicrosoftDocs/windows-dev-docs-pr#7418.
- Chart (2.5-experimental): draft coverage remains in MicrosoftDocs/windows-dev-docs-pr#7337 and MicrosoftDocs/windows-dev-docs-pr#7429. Both add
chart.md; reconcile the overlapping articles before merging. The latter also adds the Gallery deep link and setup diagnostics. - InkCanvas / InkToolbar: Inking controls covers experimental WinUI inking, delivered by MicrosoftDocs/windows-dev-docs-pr#7419.
- WrapPanel and PagerControl: published WrapPanel and PagerControl guidance. The Gallery samples still have empty
Docsarrays. - LayoutPanel: Attached layouts now explains its experimental status, properties, and behavior.
- Windowing (
Window.Width,Height,MinWidth,MinHeight,MaxWidth,MaxHeight): Manage app windows now covers experimental XAML Window sizing, logical versus physical pixels, size limits, and validation. The Gallery sample's release-channels link still needs correction under section 2.
WrapPanel, PagerControl, LayoutPanel, and window sizing were delivered by MicrosoftDocs/windows-dev-docs-pr#7415. All five completed experimental checklist items have published guidance verified on November 8.
2. Gallery fixes in ControlInfoData.json
Still outstanding as of November 8: the published docs above don't update the Gallery's Docs entries automatically. The missing links, wrong/legacy links, and protocol activation behavior below remain present in Gallery main.
Docs pages that exist but aren't linked from the sample
-
SelectorBar→ https://learn.microsoft.com/windows/apps/develop/ui/controls/selector-bar -
ItemsView→ https://learn.microsoft.com/windows/apps/develop/ui/controls/itemsview -
AnnotatedScrollBar→ https://learn.microsoft.com/windows/apps/develop/ui/controls/annotated-scrollbar -
MapControl→ https://learn.microsoft.com/windows/apps/develop/ui/controls/map-control -
SystemBackdropElement→ https://learn.microsoft.com/windows/apps/develop/ui/system-backdrops#apply-a-system-backdrop-to-any-xaml-element -
SystemBackdrops→ https://learn.microsoft.com/windows/apps/develop/ui/system-backdrops -
ContentIsland→ https://learn.microsoft.com/windows/apps/develop/composition/content-island -
JumpList→ https://learn.microsoft.com/windows/apps/develop/windows-integration/jump-list -
AppWindow→ https://learn.microsoft.com/windows/apps/develop/ui/manage-app-windows and https://learn.microsoft.com/windows/apps/develop/ui/windowing-overview -
CaptureElementPreview→ https://learn.microsoft.com/windows/apps/develop/camera/camera-quickstart-winui3 -
StoragePickers→ https://learn.microsoft.com/windows/apps/develop/files/using-file-folder-pickers and https://learn.microsoft.com/windows/apps/develop/files/pickers-save-file -
TitleBar→ https://learn.microsoft.com/windows/apps/develop/ui/controls/title-bar -
LayoutPanel→ https://learn.microsoft.com/windows/apps/design/layout/attached-layouts -
WebView2→ https://learn.microsoft.com/windows/apps/develop/ui/controls/webview2 -
RadialGradientBrush→ https://learn.microsoft.com/windows/apps/develop/platform/xaml/brushes
Links that point to the wrong or a legacy page
-
Windowinglinks to release channels. It should link to https://learn.microsoft.com/windows/apps/develop/ui/windowing-overview. -
AnimatedVisualPlayerlinks to the WinUI 2.8 API reference. It should link to the Windows App SDK API and https://learn.microsoft.com/windows/apps/develop/ui/controls/animated-visual-player. -
CompactSizinglinks to/design/style/spacing, which redirects to content basics. It should link to https://learn.microsoft.com/windows/apps/develop/ui/controls/compact-sizing. -
LineandShapelink to a previous-versions page. They should link to https://learn.microsoft.com/windows/apps/develop/ui/controls/shapes. - TabView's "Show multiple views" link and the InkCanvas link go to legacy UWP pages.
- 111 of the 130 conceptual links use old URLs, mostly
/windows/apps/design/.... They still resolve through redirects, but should use the canonical URLs, mostly/windows/apps/develop/....
Make deep links more forgiving
- Update protocol activation in
App.xaml.cs. It compares IDs case-sensitively after it strips every/fromUri.LocalPath, and it silently falls back to the Home page. The docs fixes below won't reach every published page and external link, so consider:- case-insensitive ID matching,
- aliases for renamed or removed IDs, such as
Colors→ColorandCreateMultipleWindows→Windowing, - support for the single-slash
winui3gallery:/category/<id>form.
3. Deep links from docs into the gallery
The broken links were fixed by MicrosoftDocs/windows-dev-docs-pr#7414, merged October 14:
-
winui3gallery://item/Colors(x2): corrected toColor. -
winui3gallery://item/CreateMultipleWindows: corrected toWindowing. -
winui3gallery://item/DropdownButton: corrected toDropDownButton. -
winui3gallery:/category/DateAndTime,/Layout, and/MultipleWindows: corrected to the double-slash form. - Give the remaining samples an inbound docs deep link. The original gap was 38 of 126 samples. Excluding the ScratchPad playground from docs-coverage requirements, the November 8 audit of docs
mainfinds 122 of 125 in-scope samples covered, 185 links across 128 Markdown pages, and 0 broken links. OnlyBorder,Chart, andViewboxstill need an inbound link. Chart's link is included in the open MicrosoftDocs/windows-dev-docs-pr#7429; don't count it as complete until merged.
November 8 follow-up and open docs PRs
-
microsoft/WinUI-Gallery#2288: updates Docs metadata for 118 samples, adds the missing published conceptual links, and corrects canonical destinations. Pending merge; would increase Gallery-to-docs conceptual coverage from 102/125 to 124/125 in-scope samples. Chart remains pending; ScratchPad and protocol behavior are unchanged. Section 2 link tasks remain unchecked until merge.
-
MicrosoftDocs/windows-dev-docs-pr#7470: adds inbound Gallery links beside existing Border and Viewbox guidance. Pending merge; would raise in-scope coverage from 122/125 to 124/125, leaving only Chart. ScratchPad remains excluded.
-
MicrosoftDocs/windows-dev-docs-pr#7337: draft, full Chart conceptual guidance.
-
MicrosoftDocs/windows-dev-docs-pr#7429: draft, overlapping Chart overview with a Gallery link, Chart/TableView setup diagnostics in release notes, and navigation entries. Chart coverage is not complete yet.
-
MicrosoftDocs/windows-dev-docs-pr#7428: draft, additional TableView resource-setup diagnostics and dictionary ordering. This enhances the already-published TableView article; it doesn't block checking off basic conceptual coverage.
-
MicrosoftDocs/windows-dev-docs-pr#6385: draft, changes the appearance of existing Gallery buttons on the Buttons page. It doesn't close any remaining coverage gap.
Audit baselines: docs main at ce77930d8d169ade9cc7c093bb865af1882c4716; Gallery main at bb806ba9200379cd5a47ad7da0fa2598b75cb16b. Inbound-link counts cover Markdown under hub/ and validate IDs against the current Gallery metadata and case-sensitive activation behavior. Open PR content is reported separately, not counted as published coverage.
- Lenguaje dominante
- C#
- Estrellas
- 3.7k
- Forks
- 766
- Merge medio
- 3 d 10 h
- PR fusionados (30 d)
- 7
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de microsoft/WinUI-Gallery
-
needs-triage
Dificultad 2/5 1-3 horas Aptitud para principiantes 64/100
microsoft/WinUI-Gallery#2290 ·
-
random 'Fuchsia' labelAbiertobug needs-triage
Dificultad 3/5 1-2 días Aptitud para principiantes 49/100
microsoft/WinUI-Gallery#2282 ·
-
bug needs-triage
Dificultad 3/5 1-2 días Aptitud para principiantes 58/100
microsoft/WinUI-Gallery#2211 · 2 reacciones ·
-
needs-triage
Dificultad 3/5 1-2 días Aptitud para principiantes 68/100
microsoft/WinUI-Gallery#2200 · 6 comentarios · 1 reacción ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 58/100
microsoft/WinUI-Gallery#2174 · 2 comentarios ·
Todos los issues de microsoft/WinUI-Gallery
Issues similares
-
4.x bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 63/100
Los mantenedores suelen responder en 1 día
-
quality 提案 要トリアージ
Dificultad 2/5 1-3 horas Aptitud para principiantes 64/100
Los mantenedores suelen responder en 1 día
-
The Language and Region lists in Options read to a screen reader as "LanguageInfo { Id = ar, ... }"Abiertobug localization small ui
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
hexide-io/HexIDE#4176 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día