Skip to content

Changes to sample header/desc#848

Open
niels9001 wants to merge 1 commit intomainfrom
niels9001/header-desc-improvements
Open

Changes to sample header/desc#848
niels9001 wants to merge 1 commit intomainfrom
niels9001/header-desc-improvements

Conversation

@niels9001
Copy link
Copy Markdown
Collaborator

Fixes

PR Type

What kind of change does this PR introduce?

What is the current behavior?

What is the new behavior?

PR Checklist

Please check if your PR fulfills the following requirements:

  • Created a feature/dev branch in your fork (vs. submitting directly from a commit on main)
  • Based off latest main branch of toolkit
  • Tested code with current supported SDKs
  • New component
    • Documentation has been added
    • Sample in sample app has been added
    • Analyzers are passing for documentation and samples
    • Icon has been created (if new sample) following the Thumbnail Style Guide and templates
  • Tests for the changes have been added (if applicable)
  • Header has been added to all new source files
  • Contains NO breaking changes

Other information

@lei9444
Copy link
Copy Markdown

lei9444 commented Apr 28, 2026

Thanks for the PR — that closed out 5 placeholders. Here's the rest, grouped by file. The underlying issue isn't missing functionality — it's that several samples use placeholder or low-signal labels or lack a clear sample-level semantic title/description. That makes automated extraction fall back to generic labels like "Basic usage" or "Example N", which hurts discoverability for agents/tools.

Group A — multi-instance demos with placeholder per-card content

components/Segmented/samples/SegmentedBasicSample.xaml All controls:SegmentedItem still "Item 1/2/3/4" — replace with real-world labels.
components/Segmented/samples/SegmentedStylesSample.xaml First Segmented section still uses Item 1 / Item 2 / Item with long label /Item 4 (the second Day/Week/Month section is already good).
components/SettingsControls/samples/SettingsCardSample.xaml First card still has Header="This is the Header" + Description="This is a default card..." — placeholder, would benefit from a real-world Header (e.g. "Auto-save").

Group B — single-sample demos lacking a sample-level semantic title (19 files)

These all have one big demo. Some DO have inner Headers (HeaderedContentControl: "Rectangle content"; SettingsExpander: "SettingsExpander", "A basic SettingsCard within...", etc.; TabbedCommandBar: "Home", "Insert", "Picture Format") but none have a sample-level title my tool can stably pick up, so we fall back to "Basic usage". Three options to fix:

  • Add a sample-level title (a top TextBlock or attribute), OR
  • Split into 2–3 named sub-sections like SettingsCardSample does, OR
  • For controls without a Header property (layout panels, ImageCropper, ColorPicker etc.), wrap each demo block in a labeled section (Border + Header TextBlock).

components/Collections/samples/AdvancedCollectionViewSample.xaml components/Collections/samples/IncrementalLoadingCollectionSample.xaml
components/ColorPicker/samples/ColorPickerSample.xaml components/ColorPicker/samples/ColorPickerButtonSample.xaml
components/HeaderedControls/samples/HeaderedContentControlSample.xaml components/ImageCropper/samples/ImageCropperSample.xaml
components/MetadataControl/samples/MetadataControlSample.xaml components/Primitives/samples/DockPanelSample.xaml
components/Primitives/samples/StaggeredLayoutSample.xaml components/Primitives/samples/StaggeredPanelSample.xaml
components/Primitives/samples/UniformGridSample.xaml components/Primitives/samples/WrapLayoutSample.xaml
components/Primitives/samples/WrapPanelSample.xaml components/RadialGauge/samples/RadialGaugeSample.xaml
components/RangeSelector/samples/RangeSelectorSample.xaml components/SettingsControls/samples/SettingsExpanderSample.xaml
components/Sizers/samples/GridSplitterPage.xaml components/TabbedCommandBar/samples/TabbedCommandBarSample.xaml
components/TokenizingTextBox/samples/TokenizingTextBoxSample.xaml

Group C — file name hints at variant but the description is too short

The split sample files already exist with meaningful names, but my tool's auto-derived description is just one or two words pulled from the filename. A one-sentence Description on the wrapping element (or a short comment my parser could pick up) would make these searchable.

components/HeaderedControls/samples/HeaderedContentControlComplexSample.xaml ("Complex" — what kind?)
components/HeaderedControls/samples/HeaderedContentControlImageSample.xaml ("Image" — header? content?)
components/HeaderedControls/samples/HeaderedContentControlTextSample.xaml ("Text" — header? content?)
components/ImageCropper/samples/ImageCropperOverlaySample.xaml ("Overlay") components/Sizers/samples/ContentSizerLeftShelfPage.xaml("Left Shelf") components/Sizers/samples/ContentSizerTopShelfPage.xaml ("Top Shelf")
components/Sizers/samples/PropertySizerNavigationViewPage.xaml ("Navigation View") components/Sizers/samples/SizerCursorPage.xaml("Sizer Cursor")

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants