- 
                Notifications
    You must be signed in to change notification settings 
- Fork 156
Added docs for Animation package revamp #443
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.
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
Added docs for Animation package revamp #443
Conversation
10122ba    to
    c6a0f9d      
    Compare
  
    There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For any removed docs, we should leave a stub and eventually provide a migration to the new format. For now, we should add a deprecation notice at the top.
And we should move them to the 'archived' branch of the TOC, but not move the file locations (for now)
43bc86c    to
    60bf2f3      
    Compare
  
    | @michael-hawker I've reverted those changes with a rebase and added those deprecation banners instead, thanks! 🙂 | 
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Those animated GIFs are ginormous. Can we crop them and optimize them a bit? We should also have them say "This is Sample Text".
| > [!WARNING] | ||
| > These animation types have been updated with some breaking changes, please refer to the docs for the [`AnimationSet`](AnimationSet.md) and [`ImplicitAnimationSet`](ImplicitAnimationSet.md) types. For a comprehensive list of all the available APIs, use the .NET API browser instead. | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is much more of a release notes thing. Are all the samples below up-to-date to work with the new version? If so, I don't think we need this note here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not really, I've actually moved this whole page to the archive and split the docs into separate pages, since we now have the whole distinction between implicit/explicit animations (and the animation builder too) that wasn't there before. As in, this original docs page was covering mostly just the implicit ones in the old implementation, so I figured we'd just leave this here to avoid breaking links but then start fresh with the other new docs pages? 🤔
|  | ||
| # Implicit Composition Animations in XAML | ||
|  | ||
| > [!WARNING] | 
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The examples below are still workable in the new world, eh? But not in the new ImplicitAnimationSet document? Do we really need a new doc or can we just re-use the old one here and update it? (Just want to try and maybe create a bit less churn if we can?)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
They should roughly work without XAML changes I think (with some minor differences in some cases).
I just split the documents to clearly separate the various types though? As in, now we have the implicit/explicit sets, whereas before there was just that single set, and the various docs pages had more generic titles and names (eg. "composition animations"). My rationale here was that just using the type name for the file name and title would've made things easier to follow? Also to be consistent with the other docs from other sections. Thoughts? 🤔
|  | ||
| # ReorderGridAnimation | ||
|  | ||
| > [!WARNING] | 
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, this seems churny too... Maybe I should go figure out the redirect stuff... ☹
60bf2f3    to
    9f432d4      
    Compare
  
    | Docs Build status updates of commit 9f432d4: 
 | 
| File | Status | Preview URL | Details | 
|---|---|---|---|
| docs/animations/Offset.md | View | Details | |
| docs/animations/AnimationBuilder.md | ✅Succeeded | View | |
| docs/animations/AnimationSet.md | ✅Succeeded | View | |
| docs/animations/Blur.md | ✅Succeeded | View | |
| docs/animations/CompositionAnimations.md | ✅Succeeded | View | |
| docs/animations/Fade.md | ✅Succeeded | View | |
| docs/animations/ImplicitAnimationSet.md | ✅Succeeded | View | |
| docs/animations/ImplicitAnimations.md | ✅Succeeded | View | |
| docs/animations/ItemsReorderAnimation.md | ✅Succeeded | View | |
| docs/animations/Light.md | ✅Succeeded | View | |
| docs/animations/ReorderGrid.md | ✅Succeeded | View | |
| docs/animations/Rotate.md | ✅Succeeded | View | |
| docs/animations/Saturation.md | ✅Succeeded | View | |
| docs/animations/Scale.md | ✅Succeeded | View | |
| docs/resources/images/AnimationSet.gif | ✅Succeeded | View | |
| docs/resources/images/EffectAnimations.gif | ✅Succeeded | View | |
| docs/resources/images/ImplicitAnimationSet.gif | ✅Succeeded | View | |
| docs/toc.md | ✅Succeeded | View | 
docs/animations/Offset.md
- Line 123, Column 5: [Warning-duplicate-alt-text] Alt text 'Use Case 2 Output' is duplicated. Within an article, alt text must be unique.
- Line 146, Column 5: [Warning-duplicate-alt-text] Alt text 'Use Case 2 Output' is duplicated. Within an article, alt text must be unique.
For more details, please refer to the build report.
If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.
Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.
Note: Your PR may contain errors or warnings 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 docs.microsoft.com contributor guides
- Post your question in the Docs support channel
| @Sergio0694 can you address the markdown linter errors? | 
9f432d4    to
    69d4ee3      
    Compare
  
    | Docs Build status updates of commit 69d4ee3: 
 | 
| File | Status | Preview URL | Details | 
|---|---|---|---|
| docs/animations/Offset.md | View | Details | |
| docs/animations/AnimationBuilder.md | ✅Succeeded | View | |
| docs/animations/AnimationSet.md | ✅Succeeded | View | |
| docs/animations/Blur.md | ✅Succeeded | View | |
| docs/animations/CompositionAnimations.md | ✅Succeeded | View | |
| docs/animations/Fade.md | ✅Succeeded | View | |
| docs/animations/ImplicitAnimationSet.md | ✅Succeeded | View | |
| docs/animations/ImplicitAnimations.md | ✅Succeeded | View | |
| docs/animations/ItemsReorderAnimation.md | ✅Succeeded | View | |
| docs/animations/Light.md | ✅Succeeded | View | |
| docs/animations/ReorderGrid.md | ✅Succeeded | View | |
| docs/animations/Rotate.md | ✅Succeeded | View | |
| docs/animations/Saturation.md | ✅Succeeded | View | |
| docs/animations/Scale.md | ✅Succeeded | View | |
| docs/resources/images/AnimationSet.gif | ✅Succeeded | View | |
| docs/resources/images/EffectAnimations.gif | ✅Succeeded | View | |
| docs/resources/images/ImplicitAnimationSet.gif | ✅Succeeded | View | |
| docs/toc.md | ✅Succeeded | View | 
docs/animations/Offset.md
- Line 127, Column 5: [Warning-duplicate-alt-text] Alt text 'Use Case 2 Output' is duplicated. Within an article, alt text must be unique.
- Line 151, Column 5: [Warning-duplicate-alt-text] Alt text 'Use Case 2 Output' is duplicated. Within an article, alt text must be unique.
For more details, please refer to the build report.
If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.
Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.
Note: Your PR may contain errors or warnings 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 docs.microsoft.com contributor guides
- Post your question in the Docs support channel
| Docs Build status updates of commit 1bf7585: 
 | 
| Docs Build status updates of commit e174fdd: 
 | 
e174fdd    to
    4ef15b0      
    Compare
  
    4ef15b0    to
    85ed857      
    Compare
  
    | @michael-hawker Done! 😄 | 
| Docs Build status updates of commit 85ed857: ✅ Validation status: passed
 For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please: 
 | 
| @Sergio0694 should we use the new GIFs here? Also conflict now, so think once we tweak that we're good? | 
85ed857    to
    c4042bb      
    Compare
  
    | Docs Build status updates of commit c4042bb: ✅ Validation status: passed
 For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please: 
 | 
| Docs Build status updates of commit 6ddca69: ✅ Validation status: passed
 For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please: 
 | 
6ddca69    to
    75f25e2      
    Compare
  
    | Docs Build status updates of commit 75f25e2: ✅ Validation status: passed
 For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please: 
 | 
| Docs Build status updates of commit 733c200: ✅ Validation status: passed
 For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please: 
 | 
Docs for CommunityToolkit/WindowsCommunityToolkit#3639
What changes to the docs does this PR provide?
Added new docs for:
AnimationBuilderAnimationSetImplicitAnimationSetUpdated docs for
ItemsReorderAnimation.Also removed the old docs for types that are now gone.
PR Checklist
Please check if your PR fulfills the following requirements:
masterfor new features,livefor typos/improvements)