Skip to content

Ensuring items in the TOC are alphabetized for the reference section #19573

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
Merged
merged 2 commits into from
Feb 25, 2025
Merged

Ensuring items in the TOC are alphabetized for the reference section #19573

merged 2 commits into from
Feb 25, 2025

Conversation

agneszitte
Copy link
Contributor

@agneszitte agneszitte commented Feb 21, 2025 •
edited
Loading

PR Type

What kind of change does this PR introduce?

  • Refactoring (no functional changes, no api changes)

What is the current behavior?

Some non-generated and generated doc TOC items are not properly alphabetized for the reference section
image

What is the new behavior?

All non-generated and generated doc TOC items are properly alphabetized for the reference section

PR Checklist

Please check if your PR fulfills the following requirements:

@unodevops
Copy link
Contributor

🤖 Your Docs stage site is ready! Visit it here: https://unodocsprstaging.z13.web.core.windows.net/pr-19573/index.html

@github-actions github-actions bot added area/build Categorizes an issue or PR as relevant to build infrastructure kind/documentation labels Feb 21, 2025
@agneszitte agneszitte changed the title refactor: Order TOC by name instead of namespace, then name for the Generated Doc Ensuring items in the TOC are alphabetized for the reference section Feb 21, 2025
@agneszitte
Copy link
Contributor Author

@Mergifyio backport release/stable/5.6

@mergify Mergify
Copy link
Contributor

mergify bot commented Feb 21, 2025 •
edited
Loading

backport release/stable/5.6

✅ Backports have been created

@agneszitte agneszitte requested a review from ajpinedam February 21, 2025 21:40
@agneszitte agneszitte marked this pull request as ready for review February 21, 2025 21:41
ajpinedam
ajpinedam approved these changes Feb 21, 2025
View reviewed changes
Copy link
Contributor

@ajpinedam ajpinedam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Beautiful! Thanks

@agneszitte agneszitte enabled auto-merge February 24, 2025 16:33
@agneszitte agneszitte mentioned this pull request Feb 24, 2025
Open
@agneszitte agneszitte disabled auto-merge February 24, 2025 19:36
@nventive-devops
Copy link
Contributor

The build 155950 found UI Test snapshots differences: android-28-net8: 24, android-28-net8-Snap: 35, ios: 5, ios-Snap: 54, skia-gtk-screenshots: 59, skia-linux-screenshots: 67, skia-windows-screenshots: 62, wasm: 167, wasm-automated-net9.0-UWP-Default-automated: 1, wasm-automated-net9.0-UWP-RuntimeTests-0: 0, wasm-automated-net9.0-UWP-RuntimeTests-1: 0, wasm-automated-net9.0-UWP-RuntimeTests-2: 0, wasm-automated-net9.0-WinUI-Benchmarks-automated: 0, wasm-automated-net9.0-WinUI-RuntimeTests-0: 0, wasm-automated-net9.0-WinUI-RuntimeTests-1: 0, wasm-automated-net9.0-WinUI-RuntimeTests-2: 0

Details

  • android-28-net8: 24 changed over 829

    🚨🚨 Comparison Details (first 20) 🚨🚨
    • Change_Manipulation_Property_After_property_change
    • Check_CornerRadius_Border_No_CornerRadius
    • Check_CornerRadius_Border_UITests_Shared_Windows_UI_Xaml_Controls_BorderTests_Border_CornerRadius_Toggle
    • Detereminate_ProgressRing_Validation75_[#FF0000_#008000_#008000_#008000]_Progress-Ring-Value-75
    • Detereminate_ProgressRing_Validation0_[#FF0000_#FF0000_#FF0000_#FF0000]_UITests_Microsoft_UI_Xaml_Controls_ProgressRing_WinUIDeterminateProgressRing
    • Detereminate_ProgressRing_Validation50_[#FF0000_#008000_#008000_#FF0000]_Progress-Ring-Value-50
    • NativeCommandBar_Size_Uno_UI_Samples_Content_UITests_CommandBar_CommandBar_Dynamic
    • ListView_SelectedItems_SamplesApp_Windows_UI_Xaml_Controls_ListView_ListViewSelectedItems
    • Change_Manipulation_Property_Before_property_change
    • Button_IsOpacity_Validation_Uno_UI_Samples_Content_UITests_ButtonTestsControl_Button_Opacity_Automated
    • SequentialAnimations_SamplesApp_Windows_UI_Xaml_Media_Animation_SequentialAnimationsPage
    • When_MultipleSelectionWithoutItemClick_Then_PointersEvents_UITests_Windows_UI_Xaml_Controls_ListView_ListView_Selection_Pointers
    • Detereminate_ProgressRing_Validation25_[#FF0000_#008000_#FF0000_#FF0000]_Progress-Ring-Value-25
    • When_NoSelectionWithItemClick_Then_PointersEvents_UITests_Windows_UI_Xaml_Controls_ListView_ListView_Selection_Pointers
    • When_NoSelection_Then_PointersEvents_UITests_Windows_UI_Xaml_Controls_ListView_ListView_Selection_Pointers
    • Check_CornerRadius_Border_CornerRadius=5
    • When_ExtendedSelectionWithoutItemClick_Then_PointersEvents_UITests_Windows_UI_Xaml_Controls_ListView_ListView_Selection_Pointers
    • When_Parent_PointerMoved_After_drag_on_ScrollViewer_-_touch
    • When_Parent_PointerMoved_After_drag_on_non-scrolling_ScrollViewer
    • ProgressRing_Visibility_Collapsed_UITests_Windows_UI_Xaml_Controls_ProgressRing_WindowsProgressRing_GH1220

  • android-28-net8-Snap: 35 changed over 1067

    🚨🚨 Comparison Details (first 20) 🚨🚨
    • Default_Uno_UI_Samples_Content_UITests_WebView_WebView_AnchorNavigation_Uno_UI_Samples_Content_UITests_WebView_WebView_AnchorNavigation
    • MUX_NumberBox_UITests_Shared_Microsoft_UI_Xaml_Controls_NumberBoxTests_NumberBoxPage
    • TeachingTip_UITests_Microsoft_UI_Xaml_Controls_TeachingTipTests_TeachingTipPage_UITests_Microsoft_UI_Xaml_Controls_TeachingTipTests_TeachingTipPage
    • MUX_UITests_Shared_Microsoft_UI_Xaml_Controls_TreeViewTests_TreeViewPage_UITests_Shared_Microsoft_UI_Xaml_Controls_TreeViewTests_TreeViewPage
    • Scrolling_MUXControlsTestApp_ScrollViewKeyboardAndGamepadNavigationPage_MUXControlsTestApp_ScrollViewKeyboardAndGamepadNavigationPage
    • SwipeControl_MUXControlsTestApp_SwipeControlPage2_MUXControlsTestApp_SwipeControlPage2
    • Transform_TransformToVisual_Translate2d_SamplesApp_Wasm_Windows_UI_Xaml_Media_Transform_TransformToVisual_Translate2d
    • ListView_ListViewSelectedItems_SamplesApp_Windows_UI_Xaml_Controls_ListView_ListViewSelectedItems
    • MediaPlayerElement_Using_3gp_UITests_Shared_Windows_UI_Xaml_Controls_MediaPlayerElement_MediaPlayerElement_3gp_Extension
    • MediaPlayerElement_Using_mp3_Audio_only_UITests_Shared_Windows_UI_Xaml_Controls_MediaPlayerElement_MediaPlayerElement_Mp3_Extension
    • MediaPlayerElement_Using_ogg_UITests_Shared_Windows_UI_Xaml_Controls_MediaPlayerElement_MediaPlayerElement_Ogg_Extension
    • WebView_UITests_Microsoft_UI_Xaml_Controls_WebView2Tests_WebView2_NavigationProperties_UITests_Microsoft_UI_Xaml_Controls_WebView2Tests_WebView2_NavigationProperties
    • WebView_UITests_Microsoft_UI_Xaml_Controls_WebViewTests_WebView_InvokeScriptAsync_UITests_Microsoft_UI_Xaml_Controls_WebViewTests_WebView_InvokeScriptAsync
    • WebView_UITests_Windows_UI_Xaml_Controls_WebView_WebView_Title_UITests_Windows_UI_Xaml_Controls_WebView_WebView_Title
    • WebView_WebView2_JavascriptInvoke_SamplesApp_Microsoft_UI_Xaml_Controls_WebView2Tests_WebView2_JavascriptInvoke
    • RatingControl_UITests_Microsoft_UI_Xaml_Controls_RatingControlTests_RatingControlPage_UITests_Microsoft_UI_Xaml_Controls_RatingControlTests_RatingControlPage
    • x_Bind_NoPhase_Large_Uno_UI_Samples_Content_UITests_XBind_NoPhaseBinding_Large
    • WebView_WebView_NavigateToUri_Uno_UI_Samples_Content_UITests_WebView_WebView_NavigateToUri
    • WebView_WebView2_NavigateToUri_SamplesApp_Microsoft_UI_Xaml_Controls_WebView2Tests_WebView2_NavigateToUri
    • Scrolling_MUXControlsTestApp_ScrollViewWithScrollControllersPage_MUXControlsTestApp_ScrollViewWithScrollControllersPage

  • ios: 5 changed over 267

    🚨🚨 Comparison Details (first 20) 🚨🚨
    • When_SingleSelectionWithoutItemClick_Then_PointersEvents_UITests_Windows_UI_Xaml_Controls_ListView_ListView_Selection_Pointers
    • TextBox_UpdatedBinding_On_OneWay_Mode_UITests_Windows_UI_Xaml_Controls_TextBox_TextBox_Bindings
    • When_MultipleSelectionWithoutItemClick_Then_PointersEvents_UITests_Windows_UI_Xaml_Controls_ListView_ListView_Selection_Pointers
    • ProgressRing_Visibility_Collapsed_UITests_Windows_UI_Xaml_Controls_ProgressRing_WindowsProgressRing_GH1220
    • ProgressRing_IsEnabled_Running_UITests_Windows_UI_Xaml_Controls_ProgressRing_WindowsProgressRing_GH1220

  • ios-Snap: 54 changed over 1058

    🚨🚨 Comparison Details (first 20) 🚨🚨
    • Brushes_BorderImageBrush_Uno_UI_Samples_UITests_ImageBrushTestControl_BorderImageBrush
    • Brushes_PathImageBrushfill_Uno_UI_Samples_UITests_ImageBrushTestControl_PathImageBrushfill
    • ContentPresenter_ContentPresenter_Background_Uno_UI_Samples_Content_UITests_ContentPresenter_ContentPresenter_Background
    • Grid_Grid_DataBound_ColumnRow_Definitions_Uno_UI_Samples_Content_UITests_GridTestsControl_Grid_DataBound_ColumnRow_Definitions
    • Icons_UITests_Microsoft_UI_Xaml_Controls_ImageIconTests_ImageIconPage_UITests_Microsoft_UI_Xaml_Controls_ImageIconTests_ImageIconPage
    • ContentControl_ContentControl_Nested_TemplatedParent_Uno_UI_Samples_Content_UITests_ContentControlTestsControl_ContentControl_Nested_TemplatedParent
    • ListView_ListView_Image_SamplesApp_Windows_UI_Xaml_Controls_ListView_ListView_Image
    • Brushes_PanelImageBrush_Uno_UI_Samples_UITests_ImageBrushTestControl_PanelImageBrush
    • TextBlock_TextBoxSizeChanging_Uno_UI_Samples_Content_UITests_TextBlockControl_TextBoxSizeChanging
    • Brushes_UITests_Shared_Windows_UI_Xaml_Media_ImageBrushTests_ImageBrush_SameWithDelay_UITests_Shared_Windows_UI_Xaml_Media_ImageBrushTests_ImageBrush_SameWithDelay
    • Pickers_UITests_Windows_UI_Xaml_Controls_CalendarView_CalendarView_Theming_UITests_Windows_UI_Xaml_Controls_CalendarView_CalendarView_Theming
    • Brushes_ImageBrushStretch2_Uno_UI_Samples_UITests_ImageBrushTestControl_ImageBrushStretch2
    • Brushes_UITests_Windows_UI_Xaml_Media_BrushesTests_RevealBrush_Fallback_UITests_Windows_UI_Xaml_Media_BrushesTests_RevealBrush_Fallback
    • Brushes_Uno_UI_Samples_UITests_ImageBrushTestControl_DoubleImageBrushInList_Uno_UI_Samples_UITests_ImageBrushTestControl_DoubleImageBrushInList
    • ComboBox_ComboBox_ComboBoxItem_Selection_UITests_Shared_Windows_UI_Xaml_Controls_ComboBox_ComboBox_ComboBoxItem_Selection
    • Image_UITests_Shared_Windows_UI_Xaml_Controls_ImageTests_Image_Stretch_Algmnt_Inf_Horizontal_UITests_Shared_Windows_UI_Xaml_Controls_ImageTests_Image_Stretch_Algmnt_Inf_Horizontal
    • Image_UITests_Shared_Windows_UI_Xaml_Controls_ImageTests_Image_Stretch_Algmnt_Inf_Vertical_UITests_Shared_Windows_UI_Xaml_Controls_ImageTests_Image_Stretch_Algmnt_Inf_Vertical
    • Image_UITests_Shared_Windows_UI_Xaml_Controls_ImageTests_Image_Stretch_Alignment_SizeOnControl_UITests_Shared_Windows_UI_Xaml_Controls_ImageTests_Image_Stretch_Alignment_SizeOnControl
    • Brushes_ImageBrushWithScaleTransform_Uno_UI_Samples_UITests_ImageBrushTestControl_ImageBrushWithScaleTransform
    • Brushes_Uno_UI_Samples_Samples_Shared_Content_UITests_ImageBrushInList_Uno_UI_Samples_Samples_Shared_Content_UITests_ImageBrushInList

  • skia-gtk-screenshots: 59 changed over 2238

    🚨🚨 Comparison Details (first 20) 🚨🚨
    • Gamepad_Enumeration.png
    • ToggleButton_IsEnabled_Automated.png-dark
    • ToggleButton_IsEnabled_Automated.png
    • ContentPresenter_NativeEmbedding.png-dark
    • Gamepad_Enumeration.png-dark
    • TransformToVisual_Simple.png-dark
    • TransformToVisual_Simple.png
    • CompositionPath.png-dark
    • CompositionPath.png
    • DragDrop_TestPage.png-dark
    • CalendarView_Theming.png
    • ImageInStackPanel.png-dark
    • ImageInStackPanel.png
    • CalendarView_Theming.png-dark
    • PasswordBox_AutoFill.png-dark
    • PasswordBox_AutoFill.png
    • WinUIExpanderPage.png-dark
    • WinUIExpanderPage.png
    • DisplayInformation.png-dark
    • DisplayInformation.png

  • skia-linux-screenshots: 67 changed over 2238

    🚨🚨 Comparison Details (first 20) 🚨🚨
    • Buttons.png-dark
    • Gamepad_CurrentReading.png-dark
    • Gamepad_CurrentReading.png
    • Gamepad_Enumeration.png-dark
    • Gamepad_Enumeration.png
    • DisplayInformation.png-dark
    • DisplayInformation.png
    • Focus_FocusVisual_Properties.png-dark
    • Focus_FocusVisual_Properties.png
    • ImageIconPage.png-dark
    • ImageIconPage.png
    • ImageInStackPanel.png-dark
    • ImageInStackPanel.png
    • ButtonClippingTestsControl.png-dark
    • ClipboardTests.png-dark
    • ClipboardTests.png
    • Image_Formats.png-dark
    • Image_Formats.png
    • Image_Stretch_None.png-dark
    • Image_Stretch_None.png

  • skia-windows-screenshots: 62 changed over 2238

    🚨🚨 Comparison Details (first 20) 🚨🚨
    • ButtonClippingTestsControl.png-dark
    • CalendarView_Theming.png-dark
    • ClipboardTests.png-dark
    • ClipboardTests.png
    • ContentPresenter_NativeEmbedding.png-dark
    • ContentPresenter_NativeEmbedding.png
    • Buttons.png-dark
    • Ellipse.png-dark
    • Ellipse.png
    • ImageBrushAlignmentXY2.png-dark
    • ImageBrushAlignmentXY2.png
    • CompositionPath.png-dark
    • CompositionPath.png
    • DisplayInformation.png-dark
    • DisplayInformation.png
    • BorderImageBrush.png
    • BorderImageBrush.png-dark
    • CalendarView_Theming.png
    • Focus_FocusVisual_Properties.png-dark
    • Focus_FocusVisual_Properties.png

  • wasm: 167 changed over 1043

    🚨🚨 Comparison Details (first 20) 🚨🚨
    • initial_state
    • SamplesApp.Windows_UI_Xaml_Controls.ListView.ListViewHeaderFooter_ImplicitlyBinded
    • SamplesApp.Windows_UI_Xaml_Controls.ListView.ListView_Last_Item_Large
    • UITests.Microsoft_UI_Xaml_Controls.NavigationViewTests.NavigationViewBasicPage
    • UITests.Shared.Windows_Devices.Midi.MidiDeviceEnumerationTests
    • UITests.Shared.Windows_Devices.Midi.MidiDeviceOutputTests
    • UITests.Shared.Windows_UI_Xaml_Controls.Buttons_Native
    • UITests.Shared.Windows_UI_Xaml_Controls.ListView.ListView_ItemsPanel_HotSwap
    • UITests.Shared.Windows_UI_Xaml_Controls.ListView.ListView_Margin_On_Container
    • UITests.Shared.Windows_UI_Xaml_Controls.TextBoxTests.TextBox_MaxLength
    • UITests.Windows_UI_Xaml_Controls.TextBox.TextBox_SelectionHighlightColor
    • UITests.Windows_UI_Xaml_Controls.TextBox.TextBox_VerticalAlignment
    • Benchmarks.Shared.Controls.BenchmarkDotNetTestsPage
    • MUXControlsTestApp.NavigationViewBlankPage1
    • SamplesApp.Wasm.Windows_UI_Xaml_Media.Transform.TextBox_With_RotateTransform
    • SamplesApp.Windows_UI_Xaml_Controls.ListView.ListView_Image
    • UITests.Microsoft_UI_Xaml_Controls.RefreshContainerTests.RefreshContainerTheming
    • UITests.Shared.Windows_UI_Input.GestureRecognizerTests.RightTappedTests
    • UITests.Windows_UI_ViewManagement.ApplicationViewSizing
    • Uno.UI.Samples.Content.UITests.ButtonTestsControl.ComboBox_Simple

  • wasm-automated-net9.0-UWP-Default-automated: 1 changed over 23

    🚨🚨 Comparison Details (first 20) 🚨🚨
    • TestProgressRing_InitialState_UITests_Microsoft_UI_Xaml_Controls_ProgressRing_WinUIProgressRing_Features

  • wasm-automated-net9.0-UWP-RuntimeTests-0: 0 changed over 1

  • wasm-automated-net9.0-UWP-RuntimeTests-1: 0 changed over 1

  • wasm-automated-net9.0-UWP-RuntimeTests-2: 0 changed over 1

  • wasm-automated-net9.0-WinUI-Benchmarks-automated: 0 changed over 1

  • wasm-automated-net9.0-WinUI-RuntimeTests-0: 0 changed over 1

  • wasm-automated-net9.0-WinUI-RuntimeTests-1: 0 changed over 1

  • wasm-automated-net9.0-WinUI-RuntimeTests-2: 0 changed over 1

@agneszitte agneszitte merged commit df43809 into master Feb 25, 2025
115 checks passed
@agneszitte agneszitte deleted the dev/agzi/AdjustOrderGeneratedDoc branch February 25, 2025 20:11
@mergify mergify bot mentioned this pull request Feb 25, 2025
Merged
6 tasks
agneszitte added a commit that referenced this pull request Feb 26, 2025
@agneszitte
Merge pull request #19596 from unoplatform/mergify/bp/release/stable/…
e9b1cae 
…5.6/pr-19573

Ensuring items in the TOC are alphabetized for the reference section (backport #19573)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ajpinedam ajpinedam ajpinedam approved these changes

@Xiaoy312 Xiaoy312 Xiaoy312 approved these changes

@jeromelaban jeromelaban jeromelaban approved these changes

@MartinZikmund MartinZikmund Awaiting requested review from MartinZikmund

Assignees
No one assigned
Labels
area/build Categorizes an issue or PR as relevant to build infrastructure kind/documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@agneszitte @unodevops @nventive-devops @ajpinedam @Xiaoy312 @jeromelaban