WCT documentation update v8.1.240328-rc #393

Arlodotexe · 2024-03-29T16:39:23Z

This PR updates the Windows Community Toolkit documentation to align with the 8.1.240328-rc prerelease.

Documentation and ToC was generated by our ./tooling/Build-Toolkit-Docs.ps1 build script, detailed here.

The index.md and getting-started.md, which are not present in the generated docs, were manually re-added to the ToC, as well as the links at the bottom.

Arlodotexe · 2024-03-29T16:47:30Z

@microsoft-github-policy-service agree

michael-hawker · 2024-03-29T20:30:44Z

Thanks Arlo, not sure why we're not seeing the doc build run to give us a preview...

We also need the map of the moved docs, so we can get redirects in place.

JasonWHowell · 2024-03-30T00:02:16Z

@michael-hawker click here and then you can see the build previews:

In the build log there are View links for each changed file.
For example: https://review.learn.microsoft.com/en-us/dotnet/communitytoolkit/windows/colorpicker/index?branch=pr-en-us-393

michael-hawker · 2024-03-30T00:22:06Z

Thanks @JasonWHowell for the info, I see that now. I wasn't part of the discussion when the flag to bubble it up with the bot was turned off here: 51d7ca4 - so I'm following up with our co-owners of the repo.

The bot post certainly made it clearer when there were warnings and things we should be fixing before committing. FYI @jfversluis, started a thread on teams with the team. 😊

Arlodotexe · 2024-04-02T17:16:32Z

Example of redirects can be found here

jfversluis · 2024-04-04T08:53:53Z

Voila, careful what you wish for... A lot of warnings to fix 😜

Arlodotexe · 2024-04-15T16:37:54Z

I've added the redirects and followed the existing formatting, not sure why the warnings are still showing there.

Arlodotexe · 2024-04-15T20:53:41Z

I've added the redirects and followed the existing formatting, not sure why the warnings are still showing there.

The issue persists.

learn-build-service-prod · 2024-04-30T17:48:01Z

Learn Build status updates of commit 1b77d4c:

⚠️ Validation status: warnings

File	Status	Preview URL	Details
docs/windows/Extensions/DispatcherQueueExtensions.md	⚠️Warning	View	Details
docs/windows/Extensions/ShadowAnimations.md	⚠️Warning	View	Details
docs/windows/Sizers/GridSplitter.md	⚠️Warning	View	Details
docs/windows/Converters/index.md	💡Suggestion	View	Details
docs/windows/Extensions/FrameworkElementExtensions.md	💡Suggestion	View	Details
.openpublishing.redirection.json	✅Succeeded	View
docs/windows/Animations/Animations.md	✅Succeeded	n/a (file deleted or renamed)
docs/windows/Animations/AnimationSet.md	✅Succeeded	n/a (file deleted or renamed)
docs/windows/Animations/index.md	✅Succeeded	View
docs/windows/Behaviors/AnimationSet.md	✅Succeeded	View
docs/windows/Behaviors/Behaviors.md	✅Succeeded	n/a (file deleted or renamed)
docs/windows/Behaviors/HeaderBehaviors.md	✅Succeeded	View
docs/windows/Behaviors/index.md	✅Succeeded	View
docs/windows/Behaviors/StackedNotificationsBehavior.md	✅Succeeded	View
docs/windows/CameraPreview/CameraPreview.md	✅Succeeded	n/a (file deleted or renamed)
docs/windows/CameraPreview/index.md	✅Succeeded	View
docs/windows/Collections/AdvancedCollectionView.md	✅Succeeded	View
docs/windows/Collections/IncrementalLoadingCollection.md	✅Succeeded	View
docs/windows/ColorPicker/index.md	✅Succeeded	View
docs/windows/Converters/Converters.md	✅Succeeded	n/a (file deleted or renamed)
docs/windows/DeveloperTools/DeveloperTools.md	✅Succeeded	n/a (file deleted or renamed)
docs/windows/DeveloperTools/index.md	✅Succeeded	View
docs/windows/Extensions/AttachedDropShadow.md	✅Succeeded	View
docs/windows/Extensions/ListViewExtensions.md	✅Succeeded	View
docs/windows/Extensions/TextBoxExtensions.md	✅Succeeded	View

This comment lists only the first 25 files in the pull request.

docs/windows/Extensions/DispatcherQueueExtensions.md

Line 54, Column 19: [Warning: file-not-found - See documentation] Invalid file link: '..\helpers\DispatcherHelper.md'.

docs/windows/Extensions/ShadowAnimations.md

Line 17, Column 359: [Warning: file-not-found - See documentation] Invalid file link: '../animations/AnimationBuilder.md'.

docs/windows/Sizers/GridSplitter.md

Line 1, Column 1: [Warning: title-missing - See documentation] Missing required attribute: 'title'. Add a title string to show in search engine results.
Line 4, Column 1: [Warning: yaml-header-syntax-error - See documentation] While parsing a block mapping, did not find expected key.
Line 1, Column 1: [Suggestion: description-missing - See documentation] Missing required attribute: 'description'.

docs/windows/Converters/index.md

Line 99, Column 67: [Suggestion: preserve-view-not-set - See documentation] You've pinned this link to a specific version of content with the view parameter. It's recommended not to pin a version unless that version is A) not the default view and B) the context is about that version specifically. To proceed with pinning a version add the &preserve-view=true to the URL. Otherwise, remove the view parameter. URL: /dotnet/api/system.string.format?view=netstandard-2.0

docs/windows/Extensions/FrameworkElementExtensions.md

Line 106, Column 39: [Suggestion: learn-site-link-broken - See documentation] Link '/uwp/input-and-devices/mouse-interactions#cursors' points to a learn site page that doesn't exist. Check the path or URL and update the link.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Try searching the learn.microsoft.com contributor guides
Post your question in the Learn support channel

learn-build-service-prod · 2024-04-30T17:55:11Z

Learn Build status updates of commit 1ba9296:

⚠️ Validation status: warnings

File	Status	Preview URL	Details
docs/windows/Extensions/DispatcherQueueExtensions.md	⚠️Warning	View	Details
docs/windows/Extensions/ShadowAnimations.md	⚠️Warning	View	Details
docs/windows/Sizers/GridSplitter.md	⚠️Warning	View	Details
docs/windows/Converters/index.md	💡Suggestion	View	Details
docs/windows/Extensions/FrameworkElementExtensions.md	💡Suggestion	View	Details
.openpublishing.redirection.json	✅Succeeded	View
docs/windows/Animations/Animations.md	✅Succeeded	n/a (file deleted or renamed)
docs/windows/Animations/AnimationSet.md	✅Succeeded	n/a (file deleted or renamed)
docs/windows/Animations/index.md	✅Succeeded	View
docs/windows/Behaviors/AnimationSet.md	✅Succeeded	View
docs/windows/Behaviors/Behaviors.md	✅Succeeded	n/a (file deleted or renamed)
docs/windows/Behaviors/HeaderBehaviors.md	✅Succeeded	View
docs/windows/Behaviors/index.md	✅Succeeded	View
docs/windows/Behaviors/StackedNotificationsBehavior.md	✅Succeeded	View
docs/windows/CameraPreview/CameraPreview.md	✅Succeeded	n/a (file deleted or renamed)
docs/windows/CameraPreview/index.md	✅Succeeded	View
docs/windows/Collections/AdvancedCollectionView.md	✅Succeeded	View
docs/windows/Collections/IncrementalLoadingCollection.md	✅Succeeded	View
docs/windows/ColorPicker/index.md	✅Succeeded	View
docs/windows/Converters/Converters.md	✅Succeeded	n/a (file deleted or renamed)
docs/windows/DeveloperTools/DeveloperTools.md	✅Succeeded	n/a (file deleted or renamed)
docs/windows/DeveloperTools/index.md	✅Succeeded	View
docs/windows/Extensions/AttachedDropShadow.md	✅Succeeded	View
docs/windows/Extensions/ListViewExtensions.md	✅Succeeded	View
docs/windows/Extensions/TextBoxExtensions.md	✅Succeeded	View

This comment lists only the first 25 files in the pull request.

docs/windows/Extensions/DispatcherQueueExtensions.md

Line 54, Column 19: [Warning: file-not-found - See documentation] Invalid file link: '..\helpers\DispatcherHelper.md'.

docs/windows/Extensions/ShadowAnimations.md

Line 17, Column 359: [Warning: file-not-found - See documentation] Invalid file link: '../animations/AnimationBuilder.md'.

docs/windows/Sizers/GridSplitter.md

Line 1, Column 1: [Warning: title-missing - See documentation] Missing required attribute: 'title'. Add a title string to show in search engine results.
Line 4, Column 1: [Warning: yaml-header-syntax-error - See documentation] While parsing a block mapping, did not find expected key.
Line 1, Column 1: [Suggestion: description-missing - See documentation] Missing required attribute: 'description'.

docs/windows/Converters/index.md

Line 99, Column 67: [Suggestion: preserve-view-not-set - See documentation] You've pinned this link to a specific version of content with the view parameter. It's recommended not to pin a version unless that version is A) not the default view and B) the context is about that version specifically. To proceed with pinning a version add the &preserve-view=true to the URL. Otherwise, remove the view parameter. URL: /dotnet/api/system.string.format?view=netstandard-2.0

docs/windows/Extensions/FrameworkElementExtensions.md

Line 106, Column 39: [Suggestion: learn-site-link-broken - See documentation] Link '/uwp/input-and-devices/mouse-interactions#cursors' points to a learn site page that doesn't exist. Check the path or URL and update the link.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Try searching the learn.microsoft.com contributor guides
Post your question in the Learn support channel

learn-build-service-prod · 2024-04-30T19:22:57Z

Learn Build status updates of commit d28bb67:

✅ Validation status: passed

File	Status	Preview URL
.openpublishing.redirection.json	✅Succeeded	View
docs/windows/Animations/Animations.md	✅Succeeded	n/a (file deleted or renamed)
docs/windows/Animations/AnimationSet.md	✅Succeeded	n/a (file deleted or renamed)
docs/windows/Animations/index.md	✅Succeeded	View
docs/windows/Behaviors/AnimationSet.md	✅Succeeded	View
docs/windows/Behaviors/Behaviors.md	✅Succeeded	n/a (file deleted or renamed)
docs/windows/Behaviors/HeaderBehaviors.md	✅Succeeded	View
docs/windows/Behaviors/index.md	✅Succeeded	View
docs/windows/Behaviors/StackedNotificationsBehavior.md	✅Succeeded	View
docs/windows/CameraPreview/CameraPreview.md	✅Succeeded	n/a (file deleted or renamed)
docs/windows/CameraPreview/index.md	✅Succeeded	View
docs/windows/Collections/AdvancedCollectionView.md	✅Succeeded	View
docs/windows/Collections/IncrementalLoadingCollection.md	✅Succeeded	View
docs/windows/ColorPicker/index.md	✅Succeeded	View
docs/windows/Converters/Converters.md	✅Succeeded	n/a (file deleted or renamed)
docs/windows/Converters/index.md	✅Succeeded	View
docs/windows/DeveloperTools/DeveloperTools.md	✅Succeeded	n/a (file deleted or renamed)
docs/windows/DeveloperTools/index.md	✅Succeeded	View
docs/windows/Extensions/AttachedDropShadow.md	✅Succeeded	View
docs/windows/Extensions/DispatcherQueueExtensions.md	✅Succeeded	View
docs/windows/Extensions/FrameworkElementExtensions.md	✅Succeeded	View
docs/windows/Extensions/ListViewExtensions.md	✅Succeeded	View
docs/windows/Extensions/ShadowAnimations.md	✅Succeeded	View
docs/windows/Extensions/TextBoxExtensions.md	✅Succeeded	View
docs/windows/HeaderedControls/HeaderedContentControl.md	✅Succeeded	View

This comment lists only the first 25 files in the pull request.
For more details, please refer to the build report.

For any questions, please:

Try searching the learn.microsoft.com contributor guides
Post your question in the Learn support channel

…mment)

michael-hawker · 2024-04-30T20:55:31Z

Awesome, thanks @Arlodotexe! I believe everything in main goes live pretty quick, so we should wait to merge this until we're ready to release, right?

…mment)

learn-build-service-prod · 2024-08-12T23:43:47Z

Learn Build status updates of commit 4d78a48:

✅ Validation status: passed

File	Status	Preview URL
.openpublishing.redirection.json	✅Succeeded	View
docs/windows/Animations/Animations.md	✅Succeeded	n/a (file deleted or renamed)
docs/windows/Animations/AnimationSet.md	✅Succeeded	n/a (file deleted or renamed)
docs/windows/Animations/index.md	✅Succeeded	View
docs/windows/Behaviors/AnimationSet.md	✅Succeeded	View
docs/windows/Behaviors/Behaviors.md	✅Succeeded	n/a (file deleted or renamed)
docs/windows/Behaviors/HeaderBehaviors.md	✅Succeeded	View
docs/windows/Behaviors/index.md	✅Succeeded	View
docs/windows/Behaviors/StackedNotificationsBehavior.md	✅Succeeded	View
docs/windows/CameraPreview/CameraPreview.md	✅Succeeded	n/a (file deleted or renamed)
docs/windows/CameraPreview/index.md	✅Succeeded	View
docs/windows/Collections/AdvancedCollectionView.md	✅Succeeded	View
docs/windows/Collections/IncrementalLoadingCollection.md	✅Succeeded	View
docs/windows/ColorPicker/index.md	✅Succeeded	View
docs/windows/Converters/Converters.md	✅Succeeded	n/a (file deleted or renamed)
docs/windows/Converters/index.md	✅Succeeded	View
docs/windows/DeveloperTools/DeveloperTools.md	✅Succeeded	n/a (file deleted or renamed)
docs/windows/DeveloperTools/index.md	✅Succeeded	View
docs/windows/Extensions/AttachedDropShadow.md	✅Succeeded	View
docs/windows/Extensions/DispatcherQueueExtensions.md	✅Succeeded	View
docs/windows/Extensions/FrameworkElementExtensions.md	✅Succeeded	View
docs/windows/Extensions/ListViewExtensions.md	✅Succeeded	View
docs/windows/Extensions/ShadowAnimations.md	✅Succeeded	View
docs/windows/Extensions/TextBoxExtensions.md	✅Succeeded	View
docs/windows/HeaderedControls/HeaderedContentControl.md	✅Succeeded	View

This comment lists only the first 25 files in the pull request.
For more details, please refer to the build report.

For any questions, please:

Try searching the learn.microsoft.com contributor guides
Post your question in the Learn support channel

This reverts commit b0f7254.

learn-build-service-prod · 2024-08-21T16:15:57Z

Learn Build status updates of commit 68e147c:

✅ Validation status: passed

File	Status	Preview URL
.openpublishing.redirection.json	✅Succeeded	View
docs/windows/Animations/Animations.md	✅Succeeded	n/a (file deleted or renamed)
docs/windows/Animations/AnimationSet.md	✅Succeeded	n/a (file deleted or renamed)
docs/windows/Animations/index.md	✅Succeeded	View
docs/windows/Behaviors/AnimationSet.md	✅Succeeded	View
docs/windows/Behaviors/Behaviors.md	✅Succeeded	n/a (file deleted or renamed)
docs/windows/Behaviors/HeaderBehaviors.md	✅Succeeded	View
docs/windows/Behaviors/index.md	✅Succeeded	View
docs/windows/Behaviors/StackedNotificationsBehavior.md	✅Succeeded	View
docs/windows/CameraPreview/CameraPreview.md	✅Succeeded	n/a (file deleted or renamed)
docs/windows/CameraPreview/index.md	✅Succeeded	View
docs/windows/Collections/AdvancedCollectionView.md	✅Succeeded	View
docs/windows/Collections/IncrementalLoadingCollection.md	✅Succeeded	View
docs/windows/ColorPicker/index.md	✅Succeeded	View
docs/windows/Converters/Converters.md	✅Succeeded	n/a (file deleted or renamed)
docs/windows/Converters/index.md	✅Succeeded	View
docs/windows/DeveloperTools/DeveloperTools.md	✅Succeeded	n/a (file deleted or renamed)
docs/windows/DeveloperTools/index.md	✅Succeeded	View
docs/windows/Extensions/AttachedDropShadow.md	✅Succeeded	View
docs/windows/Extensions/DispatcherQueueExtensions.md	✅Succeeded	View
docs/windows/Extensions/FrameworkElementExtensions.md	✅Succeeded	View
docs/windows/Extensions/ListViewExtensions.md	✅Succeeded	View
docs/windows/Extensions/ShadowAnimations.md	✅Succeeded	View
docs/windows/Extensions/TextBoxExtensions.md	✅Succeeded	View
docs/windows/HeaderedControls/HeaderedContentControl.md	✅Succeeded	View

This comment lists only the first 25 files in the pull request.
For more details, please refer to the build report.

For any questions, please:

Try searching the learn.microsoft.com contributor guides
Post your question in the Learn support channel

Arlodotexe mentioned this pull request Mar 29, 2024

Minor fixes to Build-Toolkit-Docs.ps1 CommunityToolkit/Tooling-Windows-Submodule#181

Merged

This comment was marked as outdated.

Sign in to view

Arlodotexe mentioned this pull request Apr 11, 2024

Documentation fixup for v8.1 CommunityToolkit/Windows#398

Merged

Arlodotexe closed this in CommunityToolkit/Windows#398 Apr 12, 2024

Arlodotexe reopened this Apr 15, 2024

This comment was marked as outdated.

Sign in to view

Arlodotexe added a commit to Arlodotexe/CommunityToolkit that referenced this pull request Apr 30, 2024

Fixed doc warnings reported by MicrosoftDocs#393 (comment)

d28bb67

Arlodotexe added a commit to CommunityToolkit/Windows that referenced this pull request Apr 30, 2024

Fixed doc warnings reported by MicrosoftDocs/CommunityToolkit#393 (co…

5bb6134

…mment)

Arlodotexe mentioned this pull request Apr 30, 2024

Fixed remaining Microsoft Learn doc warnings CommunityToolkit/Windows#410

Merged

Arlodotexe added a commit to CommunityToolkit/Windows that referenced this pull request May 17, 2024

Fixed doc warnings reported by MicrosoftDocs/CommunityToolkit#393 (co…

5eb73f6

…mment)

Arlodotexe added 16 commits August 21, 2024 09:14

WCT documentation update v8.1.240328-rc

70ea85f

Adding redirects

0710697

Add missing authors

3bc1519

Renamed Behaviors.Animations to AnimationSet

c43c9d9

Update AnimationSet link in ToC

a9253db

Fix redirect urls

bf1093a

Add redirect_document_id

fa0caf1

Use lowercase for redirect_url

c5515da

Use root-relative path for source_path redirections

bdb9fb9

Remove leading forward slash from source_path

c9ba04b

Use root path for redirect_url

01427b9

Revert "Use root path for redirect_url"

4526d70

This reverts commit b0f7254.

Set redirect_document_id to false

85cf95e

Use source_path_from_root instead of source_path

c870c7c

Fixed doc warnings reported by MicrosoftDocs#393 (comment)

c2bb98c

Regenerated 8.1 docs from CommunityToolkit/Windows@9c7642f

68e147c

michael-hawker force-pushed the windows/update/8.1.240329-rc branch from 4d78a48 to 68e147c Compare August 21, 2024 16:14

michael-hawker approved these changes Aug 21, 2024

View reviewed changes

michael-hawker merged commit 2931111 into MicrosoftDocs:main Aug 22, 2024
2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WCT documentation update v8.1.240328-rc #393

WCT documentation update v8.1.240328-rc #393

Arlodotexe commented Mar 29, 2024 •

edited

Loading

Arlodotexe commented Mar 29, 2024

michael-hawker commented Mar 29, 2024

JasonWHowell commented Mar 30, 2024

michael-hawker commented Mar 30, 2024

Arlodotexe commented Apr 2, 2024

This comment was marked as outdated.

jfversluis commented Apr 4, 2024

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

Arlodotexe commented Apr 15, 2024 •

edited

Loading

This comment was marked as outdated.

Arlodotexe commented Apr 15, 2024 •

edited

Loading

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

learn-build-service-prod bot commented Apr 30, 2024

learn-build-service-prod bot commented Apr 30, 2024

learn-build-service-prod bot commented Apr 30, 2024

michael-hawker commented Apr 30, 2024

learn-build-service-prod bot commented Aug 12, 2024

learn-build-service-prod bot commented Aug 21, 2024

WCT documentation update v8.1.240328-rc #393

WCT documentation update v8.1.240328-rc #393

Conversation

Arlodotexe commented Mar 29, 2024 • edited Loading

Arlodotexe commented Mar 29, 2024

michael-hawker commented Mar 29, 2024

JasonWHowell commented Mar 30, 2024

michael-hawker commented Mar 30, 2024

Arlodotexe commented Apr 2, 2024

This comment was marked as outdated.

jfversluis commented Apr 4, 2024

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

Arlodotexe commented Apr 15, 2024 • edited Loading

This comment was marked as outdated.

Arlodotexe commented Apr 15, 2024 • edited Loading

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

learn-build-service-prod bot commented Apr 30, 2024

⚠️ Validation status: warnings

learn-build-service-prod bot commented Apr 30, 2024

⚠️ Validation status: warnings

learn-build-service-prod bot commented Apr 30, 2024

✅ Validation status: passed

michael-hawker commented Apr 30, 2024

learn-build-service-prod bot commented Aug 12, 2024

✅ Validation status: passed

learn-build-service-prod bot commented Aug 21, 2024

✅ Validation status: passed

Arlodotexe commented Mar 29, 2024 •

edited

Loading

Arlodotexe commented Apr 15, 2024 •

edited

Loading

Arlodotexe commented Apr 15, 2024 •

edited

Loading