Track docs coverage for WinUI 3 Gallery samples

オープン
#2,275 コメント 0 件 リアクション 1 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
30/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
活発
技術スタック
csharp

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

enhancement

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 using IXamlCondition.
  • Badge notifications (BadgeNotificationManager): Badge notifications now covers Microsoft.Windows.BadgeNotifications, alongside the separate UWP guidance.
  • TitleBar drag regions (TitleBar): Customize drag regions covers TitleBar.IsDragRegion, AutoRefreshDragRegions, and RecomputeDragRegions().
  • SplitMenuFlyoutItem (MenuFlyout sample): 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.

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
Links that point to the wrong or a legacy page
Make deep links more forgiving
  • Update protocol activation in App.xaml.cs. It compares IDs case-sensitively after it strips every / from Uri.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 → Color and CreateMultipleWindows → 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 to Color.
  • winui3gallery://item/CreateMultipleWindows: corrected to Windowing.
  • winui3gallery://item/DropdownButton: corrected to DropDownButton.
  • 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 main finds 122 of 125 in-scope samples covered, 185 links across 128 Markdown pages, and 0 broken links. Only Border, Chart, and Viewbox still 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.

主要言語
C#
スター
3.7k
フォーク
766
平均マージ
3日 10時間
マージ済み PR(30日)
7

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

microsoft/WinUI-Gallery のほかの issue

microsoft/WinUI-Gallery の issue をすべて見る

似ている issue

C# の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。