Docs update #1748

Vijay-Nirmal · 2018-01-18T13:43:26Z

Issue: #1226 #1569

PR Type

What kind of change does this PR introduce?

Documentation content changes

What is the new behavior?

Adding more details.

Work In Progress - Don't merge this PR until I update all docs

Does this PR introduce a breaking change? - No

skendrot

Remove the en-us from links to docs.microsoft.com

skendrot · 2018-01-18T23:53:54Z

docs/animations/FadeHeader.md

 # FadeHeader

-The FadeHeader fades a ListView or GridView Header UIElement when the user scrolls. The UIElement fades out to 0 opacity when the edge of the Header reaches the edge of the visible bounds of the ListElement.
+The [FadeHeader](https://docs.microsoft.com/en-us/dotnet/api/microsoft.toolkit.uwp.ui.animations.parallaxservice) fades a ListView or GridView Header UIElement when the user scrolls. The UIElement fades out to 0 opacity when the edge of the Header reaches the edge of the visible bounds of the ListElement.


This appears to be the wrong link

skendrot · 2018-01-18T23:59:09Z

docs/animations/AnimationSet.md

+| Then() | Wait for existing animations to complete before running new animations |

 ### EasingType



EasingType is listed under methods instead of Properties. This should be listed with the properties

skendrot · 2018-01-19T00:01:57Z

docs/animations/Blur.md

 # Blur

-The Blur animation blurs a XAML element by increasing or decreasing pixel size. Blur animation is applied to all the XAML elements in its parent control/panel. Blur animation doesn't affect the functionality of the control.
+The [Blur animation](https://docs.microsoft.com/en-us/dotnet/api/microsoft.toolkit.uwp.ui.animations.animationextensions) blurs a XAML element by increasing or decreasing pixel size. Blur animation is applied to all the XAML elements in its parent control/panel. Blur animation doesn't affect the functionality of the control.


Possible wrong link? Or do you want to link to https://docs.microsoft.com/dotnet/api/microsoft.toolkit.uwp.ui.animations.animationextensions#Microsoft_Toolkit_Uwp_UI_Animations_AnimationExtensions_BlurEffect

What if we link to the corresponding method? https://docs.microsoft.com/en-us/dotnet/api/microsoft.toolkit.uwp.ui.animations.animationextensions#Microsoft_Toolkit_Uwp_UI_Animations_AnimationExtensions_Blur_Microsoft_Toolkit_Uwp_UI_Animations_AnimationSet_System_Double_System_Double_System_Double_

skendrot · 2018-01-19T00:05:01Z

docs/animations/CompositionAnimations.md


+## Related Topics
+
+- [Visual layer](https://docs.microsoft.com/en-us/windows/uwp/composition/visual-layern)


Typo in link. Remove trailing n

skendrot · 2018-01-19T00:08:58Z

docs/animations/Fade.md

 # Fade

-The Fade animation fades objects, in and out, over time. Fade animation is applied to all the XAML elements in its parent control/panel. Fade animation doesn't affect the functionality of the control.
+The [Fade animation](https://docs.microsoft.com/en-us/dotnet/api/microsoft.toolkit.uwp.ui.animations.animationextensions) fades objects, in and out, over time. Fade animation is applied to all the XAML elements in its parent control/panel. Fade animation doesn't affect the functionality of the control.


Possible wrong link or intended to use with id #Microsoft_Toolkit_Uwp_UI_Animations_AnimationExtensions_Fade_

skendrot · 2018-01-19T00:11:49Z

docs/animations/ImplicitAnimations.md

-The Implicit Animations Attached Properties can be used in combination with the VisualExtensions. This works well when used in Storyboards.
+The Implicit Animations Attached Properties enable implicit animations to be defined in your XAML code by using the [Composition Animation](https://docs.microsoft.com/en-us/windows/uwpcommunitytoolkit/animations/compositionanimations) XAML objects. This allows animations to be defined directly on the element, or defined as XAML resources and applied to any XAML element. 
+
+The Implicit Animations Attached Properties can be used in combination with the [VisualExtensions](https://docs.microsoft.com/en-us/windows/uwpcommunitytoolkit/extensions/viewextensions). This works well when used in Storyboards.


VisualExtensions should be ViewExtensions

haha Actually, ViewExtensions should be VisualExtensions. Wrong link 😄

skendrot · 2018-01-19T00:15:25Z

docs/animations/Light.md

 # Light

-The Light animation behavior performs a point light (A point source of light that emits light in all directions) in the middle of a given UIElement. You set the distance property of the light to determine how bright the light will be. The closer the light source, the darker the UI element will be. ***NOTE**:  Heavy usage of effects may have a negative impact on the performance of your application.* 
+The [Light animation](https://docs.microsoft.com/en-us/dotnet/api/microsoft.toolkit.uwp.ui.animations.animationextensions) behavior performs a point light (A point source of light that emits light in all directions) in the middle of a given UIElement. You set the distance property of the light to determine how bright the light will be. The closer the light source, the darker the UI element will be. 


Possible wrong link or intended to use with id #Microsoft_Toolkit_Uwp_UI_Animations_AnimationExtensions_Light_

skendrot · 2018-01-19T00:16:19Z

docs/animations/Offset.md

 # Offset

-The Offset animation is used to move the control from one place to another. Offset animation is applied to all the XAML elements in its parent control/panel. Offset animation doesn't affect the functionality of the control.
+The [Offset animation](https://docs.microsoft.com/en-us/dotnet/api/microsoft.toolkit.uwp.ui.animations.animationextensions) is used to move the control from one place to another. Offset animation is applied to all the XAML elements in its parent control/panel. Offset animation doesn't affect the functionality of the control.


Add id #Microsoft_Toolkit_Uwp_UI_Animations_AnimationExtensions_Offset_ to link

skendrot · 2018-01-19T00:17:31Z

docs/animations/Rotate.md

 # Rotate

-The Rotate animation allows users to modify and animate the control's rotation. Rotate animation is applied to all the XAML elements in its parent control/panel. Rotate animation doesn't affect the functionality of the control.
+The [Rotate animation](https://docs.microsoft.com/en-us/dotnet/api/microsoft.toolkit.uwp.ui.animations.animationextensions) allows users to modify and animate the control's rotation. Rotate animation is applied to all the XAML elements in its parent control/panel. Rotate animation doesn't affect the functionality of the control.


Add id to link #Microsoft_Toolkit_Uwp_UI_Animations_AnimationExtensions_Rotate_

skendrot · 2018-01-19T00:18:18Z

docs/animations/Saturation.md

 # Saturation

-The Saturation animation selectively saturates a XAML element. Saturation animation is applied to all the XAML elements in its parent control/panel. Saturation animation doesn't affect the functionality of the control.
+The [Saturation animation](https://docs.microsoft.com/en-us/dotnet/api/microsoft.toolkit.uwp.ui.animations.animationextensions) selectively saturates a XAML element. Saturation animation is applied to all the XAML elements in its parent control/panel. Saturation animation doesn't affect the functionality of the control.


Add id to link #Microsoft_Toolkit_Uwp_UI_Animations_AnimationExtensions_Saturation_

WilliamABradley · 2018-01-26T01:24:09Z

docs/animations/AnimationSet.md

-***Note:** Blur, Light and Saturation animation don't support easing*
+> [!IMPORTANT]
+EasingType is used only when AnimationSet.UseComposition == false
+


Sorry for the late response, I had exams this week.

For now, I will keep it like this. If #1761 didn't solve this issue then we can change it.

@WilliamABradley Will code block inside a Note work?

A Note is just a skinned Quote Block, which can handle some formatting:

>```csharp > void >```

This works the same here on GitHub, as it does in the MarkdownTextBlock.

void

…mmunityToolkit#1650 to merge)

WilliamABradley · 2018-02-07T00:06:11Z

@Vijay-Nirmal @cbarkerms Onedrive and MS Graph documentation hasn't been updated since #1588, this could do with some restructuring, also the requirements need updated specifying .NET Standard support.

I like this style:

Requirements

Implementation	.NET Standard 1.4.
Namespace	Microsoft.Toolkit.Services
NuGet package	Microsoft.Toolkit.Services

nmetulev · 2018-02-13T02:42:27Z

@Vijay-Nirmal, I'm going to move this to 3.0. We can always merge for 2.2 if you get it done that fast :)

Vijay-Nirmal · 2018-02-13T11:43:40Z

@nmetulev Sorry for the delay. I am overloaded with many projects in college. I will try to complete before v2.2

nmetulev · 2018-02-13T21:47:07Z

No worries, we all get busy :). Just FYI, the code freeze for 2.2 is next Wednesday.

WilliamABradley · 2018-02-14T05:01:57Z

@Vijay-Nirmal #1650 has now been merged, you will need to merge the documentation changes with your changes. You should open the Sample app and check how your Sample pages look in the Documentation pane.

A change I made to the Sample app means that it Debug mode, the Sample App will always use the local copy of the documentation, so that editing any files will reflect in the app, rather than always getting the version from docs.microsoft.com. This means that you should now be able to preview your modifications in the Sample app.

Vijay-Nirmal · 2018-02-14T07:10:50Z

More than 60 conflicting files 😮

WilliamABradley · 2018-02-14T07:17:30Z

Visual Studio & VS Code have powerful merging tools 😄

Odonno · 2018-02-14T09:54:35Z

Or use vscode, it is freaking cool how easy & quickly you can merge with this editor.

Vijay-Nirmal · 2018-02-14T10:27:20Z

@Odonno I am already using VSCode.

windowstoolkitbot · 2018-03-26T00:00:02Z

This PR seems inactive. @Vijay-Nirmal Do you need help to complete this issue?

windowstoolkitbot · 2018-04-09T00:00:03Z

This PR seems inactive. @Vijay-Nirmal Do you need help to complete this issue?

I didn't add Properties/Methods in Linkedin, MicrosoftGraph, MicrosoftTranslator, OneDrive and Twitter

Vijay-Nirmal · 2018-04-12T06:05:33Z

I didn't add Properties/Methods in Linkedin, MicrosoftGraph, MicrosoftTranslator, OneDrive and Twitter because they will be changed when we move to Microsoft.Toolkit.Services from Microsoft.Toolkit.Uwp.Services. Also, it is very time-consuming. If you want, I will make a separate PR to do this.

Ping @WilliamABradley, @skendrot, @nmetulev for review

nmetulev · 2018-04-12T18:09:59Z

Yeah, let's split this up the rest of the work in another PR, this is becoming huge :)

Once you are ready with the current work, let us know so we can review.

Vijay-Nirmal · 2018-04-12T18:17:05Z

@nmetulev I think I finished all the work.

I didn't add Properties/Methods for Services because I got confused with Microsoft.Toolkit.Services and Microsoft.Toolkit.Uwp.Services. Anyway, we are going to change every service to Microsoft.Toolkit.Services with the next release. So, I thought it is unnecessary to add doc for .Uwp.Services. If you want, I will do it in PR.

nmetulev · 2018-04-12T21:59:09Z

Apologies, i didn't realize this was ready for review. Will review it asap.

ping @skendrot and @WilliamABradley to update their reviews

nmetulev

This is a huge PR, and I left few comments, but overall, looks great.

nmetulev · 2018-04-15T22:14:16Z

docs/animations/AnimationSet.md

                .SetDurationForAll(500);
-                .Start();
-    }
+.Start();


This breaks the code block rendering, needs few tabs

nmetulev · 2018-04-15T22:17:34Z

docs/animations/Blur.md

 # Blur

-The Blur animation blurs a XAML element by increasing or decreasing pixel size. Blur animation is applied to all the XAML elements in its parent control/panel. Blur animation doesn't affect the functionality of the control.
+The [Blur animation](https://docs.microsoft.com/dotnet/api/microsoft.toolkit.uwp.ui.animations.animationextensions#Microsoft_Toolkit_Uwp_UI_Animations_AnimationExtensions_Blur_) blurs a XAML element by increasing or decreasing pixel size. Blur animation is applied to all the XAML elements in its parent control/panel. Blur animation doesn't affect the functionality of the control.


Should this point to: https://docs.microsoft.com/dotnet/api/microsoft.toolkit.uwp.ui.animations.animationextensions.blur instead

nmetulev · 2018-04-15T22:21:17Z

docs/animations/Fade.md

 # Fade

-The Fade animation fades objects, in and out, over time. Fade animation is applied to all the XAML elements in its parent control/panel. Fade animation doesn't affect the functionality of the control.
+The [Fade animation](https://docs.microsoft.com/dotnet/api/microsoft.toolkit.uwp.ui.animations.animationextensions#Microsoft_Toolkit_Uwp_UI_Animations_AnimationExtensions_Fade_) fades objects, in and out, over time. Fade animation is applied to all the XAML elements in its parent control/panel. Fade animation doesn't affect the functionality of the control.


Url should be: https://docs.microsoft.com/dotnet/api/microsoft.toolkit.uwp.ui.animations.animationextensions.fade

nmetulev · 2018-04-15T22:21:41Z

docs/animations/FadeHeader.md

 # FadeHeader

-The FadeHeader fades a ListView or GridView Header UIElement when the user scrolls. The UIElement fades out to 0 opacity when the edge of the Header reaches the edge of the visible bounds of the ListElement.
+The [FadeHeader](https://docs.microsoft.com/dotnet/api/microsoft.toolkit.uwp.ui.animations.behaviors.fadeheaderbehavior) fades a ListView or GridView Header UIElement when the user scrolls. The UIElement fades out to 0 opacity when the edge of the Header reaches the edge of the visible bounds of the ListElement.


Same as above, change url to point to actual fade extension method

This is the current link

nmetulev · 2018-04-15T22:27:31Z

docs/animations/Offset.md

 # Offset

-The Offset animation is used to move the control from one place to another. Offset animation is applied to all the XAML elements in its parent control/panel. Offset animation doesn't affect the functionality of the control.
+The [Offset animation](https://docs.microsoft.com/dotnet/api/microsoft.toolkit.uwp.ui.animations.animationextensions#Microsoft_Toolkit_Uwp_UI_Animations_AnimationExtensions_Offset_) is used to move the control from one place to another. Offset animation is applied to all the XAML elements in its parent control/panel. Offset animation doesn't affect the functionality of the control.


change link to point to the Offset extension method

nmetulev · 2018-04-15T23:28:09Z

docs/extensions/ListViewExtensions.md

+## Sample Code

-| [Device family](http://go.microsoft.com/fwlink/p/?LinkID=526370) | Universal, 10.0.14393.0 or higher |
+[ListViewBase extentions](https://github.com/Microsoft/UWPCommunityToolkit/tree/master/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/ListViewExtensions). You can see this in action in [UWP Community Toolkit Sample App](https://www.microsoft.com/store/apps/9NBLGGH4TLCQ).


ListViewExtensions

nmetulev · 2018-04-15T23:30:45Z

docs/extensions/SurfaceDialTextboxHelper.md

-
-> [!NOTE]
-Windows Anniversary Update (10.0.14393.0) is required for this helper to work correctly.
+The [SurfaceDialTextboxHelper XAML Property](https://docs.microsoft.com/windows/uwpcommunitytoolkit/extensions/surfacedialtextboxhelper) adds features from the Surface Dial control to a numeric TextBox. This enables you to modify the content of the TextBox when rotating the Surface Dial (increasing or decreasing the value) and optionally go to the next focus element by tapping the Surface Dial click button.


This link would point to itself :)

Also, name of the helper is SurfaceDialTextbox (not SurfaceDialTextboxHelper)

nmetulev · 2018-04-15T23:32:11Z

docs/extensions/SurfaceDialTextboxHelper.md

+<Page ...
+     xmlns:extensions="using:Microsoft.Toolkit.Uwp.UI.Extensions">
+
 <TextBox Width="106"


Need to update sample to change SurfaceDialTextboxHelper to SurfaceDialTextbox

nmetulev · 2018-04-15T23:36:07Z

docs/helpers/HttpHelperRequest.md


-(This API is obsolete and will be removed in the future. Please use [System.Net.Http.HttpRequestMessage](https://msdn.microsoft.com/en-us/library/system.net.http.httprequestmessage(v=vs.110).aspx) 
-or [Windows.Web.Http.HttpRequestMessage](https://docs.microsoft.com/en-us/uwp/api/windows.web.http.httprequestmessage) directly)
+(This API is obsolete and will be removed in the future. Please use [System.Net.Http.HttpRequestMessage](https://msdn.microsoft.com/library/system.net.http.httprequestmessage(v=vs.110).aspx) 


Should this be a [WARNING]

nmetulev · 2018-04-15T23:36:38Z

docs/helpers/HttpHelperResponse.md


-(This API is obsolete and will be removed in the future. Please use [System.Net.Http.HttpResponseMessage](https://msdn.microsoft.com/en-us/library/system.net.http.httpresponsemessage(v=vs.110).aspx) 
-or [Windows.Web.Http.HttpResponseMessage](https://docs.microsoft.com/en-us/uwp/api/Windows.Web.Http.HttpResponseMessage) directly)
+(This API is obsolete and will be removed in the future. Please use [System.Net.Http.HttpResponseMessage](https://msdn.microsoft.com/library/system.net.http.httpresponsemessage(v=vs.110).aspx) 


Should this be a [!WARNING]

nmetulev · 2018-04-19T03:12:22Z

Make sure to fix conflicts.

Ping @skendrot and @WilliamABradley to update their reviews

old review

windowstoolkitbot · 2018-04-26T21:37:38Z

This PR is linked to unclosed issues. Please check if one of these issues should be closed: #1226, #1569, #1882

Vijay-Nirmal added 4 commits December 16, 2017 18:13

Merge remote-tracking branch 'upstream/master'

2ee72db

Merge remote-tracking branch 'upstream/master'

a6a801a

Animation doc update

167af09

AnimationSet link changed

725786f

nmetulev mentioned this pull request Jan 18, 2018

Markdown + RSS Parser for .NET Standard, MarkdownTextBlock Style Improvements, Syntax Highlighting #1650

Merged

12 tasks

skendrot previously requested changes Jan 19, 2018

View reviewed changes

Vijay-Nirmal mentioned this pull request Jan 19, 2018

Issues in AnimationSet doc #1569

Closed

WilliamABradley reviewed Jan 26, 2018

View reviewed changes

Vijay-Nirmal mentioned this pull request Feb 2, 2018

Known issues section in documentation #1768

Closed

Vijay-Nirmal added 6 commits February 4, 2018 19:37

Updates for control docs except for MarkdownTextBlock (waiting for Co…

b96195d

…mmunityToolkit#1650 to merge)

Fix for review

663d2bd

Doc template update

cf42fb4

DeveloperTool docs update

5dbc5f2

DeveloperTool docs update

11cf852

Small AlignmentGrid fix

5d9ef7e

nmetulev added documentation 📃 work in progress labels Feb 13, 2018

nmetulev added this to the 3.0 milestone Feb 13, 2018

Vijay-Nirmal added 2 commits February 13, 2018 23:20

Extensions docs update

7dbce8e

Merge remote-tracking branch 'upstream/master' into DocsUpdate

02df05c

Merge remote-tracking branch 'upstream/master' into DocsUpdate

6c22413

Vijay-Nirmal added 2 commits March 25, 2018 01:11

Merge remote-tracking branch 'upstream/master' into DocsUpdate

7ae0790

Notifications docs update

e308718

Vijay-Nirmal mentioned this pull request Mar 26, 2018

Stacked in-app notification #1921

Merged

6 tasks

Vijay-Nirmal added 2 commits April 12, 2018 11:30

Service docs update

82b1371

I didn't add Properties/Methods in Linkedin, MicrosoftGraph, MicrosoftTranslator, OneDrive and Twitter

Brush docs update

45f1e09

Vijay-Nirmal mentioned this pull request Apr 15, 2018

MarkdownTextBlock - Resize image when overflow and Added ImageMaxWidth and ImageMaxHeight property #1976

Merged

5 tasks

nmetulev requested changes Apr 15, 2018

View reviewed changes

nmetulev added reviewers wanted and removed work in progress labels Apr 15, 2018

Vijay-Nirmal added 3 commits April 17, 2018 15:52

Fix for review

563db9f

Merge remote-tracking branch 'upstream/master' into DocsUpdate

9534a4e

Removed C# and XAML from Syntax

80ed2ac

nmetulev approved these changes Apr 19, 2018

View reviewed changes

Merge branch 'master' into DocsUpdate

48d59bc

Merge branch 'master' into DocsUpdate

256e001

michael-hawker mentioned this pull request Apr 26, 2018

Deeplink to Sample App Samples from Docs #2027

Closed

michael-hawker approved these changes Apr 26, 2018

View reviewed changes

michael-hawker merged commit ab6a0bb into CommunityToolkit:master Apr 26, 2018

Vijay-Nirmal deleted the DocsUpdate branch April 27, 2018 02:03

nmetulev mentioned this pull request Apr 27, 2018

Add VB samples to docs #1977

Merged

7 tasks

		\| Then() \| Wait for existing animations to complete before running new animations \|

		### EasingType


		## Related Topics

		- [Visual layer](https://docs.microsoft.com/en-us/windows/uwp/composition/visual-layern)

Uh oh!

Docs update #1748

Docs update #1748

Uh oh!

Conversation

Vijay-Nirmal commented Jan 18, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Type

What is the new behavior?

Does this PR introduce a breaking change? - No

Uh oh!

skendrot left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

skendrot Jan 18, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Vijay-Nirmal Jan 19, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

WilliamABradley commented Feb 7, 2018

Requirements

Uh oh!

nmetulev commented Feb 13, 2018

Uh oh!

Vijay-Nirmal commented Feb 13, 2018

Uh oh!

nmetulev commented Feb 13, 2018

Uh oh!

WilliamABradley commented Feb 14, 2018

Uh oh!

Vijay-Nirmal commented Feb 14, 2018

Uh oh!

WilliamABradley commented Feb 14, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Odonno commented Feb 14, 2018

Uh oh!

Vijay-Nirmal commented Feb 14, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

windowstoolkitbot commented Mar 26, 2018

Uh oh!

windowstoolkitbot commented Apr 9, 2018

Uh oh!

Vijay-Nirmal commented Apr 12, 2018

Vijay-Nirmal commented Jan 18, 2018 •

edited

Loading

skendrot Jan 18, 2018 •

edited

Loading

Vijay-Nirmal Jan 19, 2018 •

edited

Loading

WilliamABradley commented Feb 14, 2018 •

edited

Loading

Vijay-Nirmal commented Feb 14, 2018 •

edited

Loading