Skip to content

Conversation

@ratishphilip
Copy link
Contributor

@ratishphilip ratishphilip commented Sep 26, 2020

Added documentation for CanvasPathGeometry and Win2d Path Mini Language.

Docs for Toolkit PR #3503

This provides documentation for CanvasPathGeometry and Win2d Path Mini Language.

PR Checklist

Please check if your PR fulfills the following requirements:

  • [x ] Correctly picked the right branch to base the change off (master for new features, live for typos/improvements)
  • For new pages, used the provided template
  • For new features, added an entry in the Table of Contents
  • Ran against a spell and grammar checker
  • Contains NO breaking changes

Added documentation for CanvasPathGeometry and Win2d Path Mini Language.
@opbld31
Copy link

opbld31 commented Jan 19, 2021

Docs Build status updates of commit 30eb4df:

⚠️ Validation status: warnings

File Status Preview URL Details
docs/parsers/CanvasPathGeometry.md ⚠️Warning View Details
docs/parsers/Win2d_Path_Mini_Language.md ⚠️Warning View Details
dotnet/xml/Microsoft.Toolkit.Uwp.UI.Controls/BackButtonBehavior.xml ⚠️Warning View Details
dotnet/xml/Microsoft.Toolkit.Win32.UI.Controls.Interop.WinRT/WebViewControlPermissionType.xml ⚠️Warning View Details
dotnet/xml/Microsoft.Toolkit.Uwp.UI.Lottie/LottieVisualSource.xml ⚠️Warning View Details
docs/resources/images/Squircle.gif ✅Succeeded View
docs/toc.md ✅Succeeded View

docs/parsers/CanvasPathGeometry.md

  • Line 2, Column 1: [Warning-title-missing] Missing required attribute: 'title'. Add a title string to show in search engine results.
  • Line 40, Column 1: [Warning-invalid-note-section] Text in the first line of Note/Section/Video is not valid. Will be rendered to <blockquote>
  • Line 46, Column 1: [Warning-insecure-link] Link 'http://aka.ms/uwptoolkitapp' is insecure. Links to Microsoft sites must use 'https' instead of 'http'.
  • Line 4, Column 14: [Suggestion-duplicate-descriptions] Attribute 'description' with value 'describe your control in one sentence' is duplicated in 'parsers/CanvasPathGeometry.md(4,14)', 'parsers/Win2d_Path_Mini_Language.md(4,14)'.

docs/parsers/Win2d_Path_Mini_Language.md

  • Line 2, Column 1: [Warning-title-missing] Missing required attribute: 'title'. Add a title string to show in search engine results.
  • Line 63, Column 1: [Warning-h1-not-first] Markdown content is not allowed before H1 'Introduction'.
  • Line 96, Column 1: [Warning-multiple-h1s] Multiple H1s(H1 'Win2d Path Mini Language') are not allowed. You can only have one top-level heading.
  • Line 868, Column 1: [Warning-multiple-h1s] Multiple H1s(H1 'Creating Geometries, Brushes, Strokes and StrokeStyles') are not allowed. You can only have one top-level heading.
  • Line 4, Column 14: [Suggestion-duplicate-descriptions] Attribute 'description' with value 'describe your control in one sentence' is duplicated in 'parsers/CanvasPathGeometry.md(4,14)', 'parsers/Win2d_Path_Mini_Language.md(4,14)'.
  • Line 126, Column 1: [Suggestion-column-header-missing] Column headers are required for tables. Add appropriate header text. NOTE: This Suggestion will become a Warning on 1/29/21.
  • Line 143, Column 1: [Suggestion-column-header-missing] Column headers are required for tables. Add appropriate header text. NOTE: This Suggestion will become a Warning on 1/29/21.
  • Line 163, Column 1: [Suggestion-column-header-missing] Column headers are required for tables. Add appropriate header text. NOTE: This Suggestion will become a Warning on 1/29/21.
  • Line 178, Column 1: [Suggestion-column-header-missing] Column headers are required for tables. Add appropriate header text. NOTE: This Suggestion will become a Warning on 1/29/21.
  • Line 193, Column 1: [Suggestion-column-header-missing] Column headers are required for tables. Add appropriate header text. NOTE: This Suggestion will become a Warning on 1/29/21.
  • Line 208, Column 1: [Suggestion-column-header-missing] Column headers are required for tables. Add appropriate header text. NOTE: This Suggestion will become a Warning on 1/29/21.
  • Line 223, Column 1: [Suggestion-column-header-missing] Column headers are required for tables. Add appropriate header text. NOTE: This Suggestion will become a Warning on 1/29/21.
  • Line 241, Column 1: [Suggestion-column-header-missing] Column headers are required for tables. Add appropriate header text. NOTE: This Suggestion will become a Warning on 1/29/21.
  • Line 256, Column 1: [Suggestion-column-header-missing] Column headers are required for tables. Add appropriate header text. NOTE: This Suggestion will become a Warning on 1/29/21.
  • Line 272, Column 1: [Suggestion-column-header-missing] Column headers are required for tables. Add appropriate header text. NOTE: This Suggestion will become a Warning on 1/29/21.
  • Line 300, Column 1: [Suggestion-column-header-missing] Column headers are required for tables. Add appropriate header text. NOTE: This Suggestion will become a Warning on 1/29/21.
  • Line 311, Column 1: [Suggestion-column-header-missing] Column headers are required for tables. Add appropriate header text. NOTE: This Suggestion will become a Warning on 1/29/21.
  • Line 322, Column 1: [Suggestion-column-header-missing] Column headers are required for tables. Add appropriate header text. NOTE: This Suggestion will become a Warning on 1/29/21.
  • Line 333, Column 1: [Suggestion-column-header-missing] Column headers are required for tables. Add appropriate header text. NOTE: This Suggestion will become a Warning on 1/29/21.
  • Line 394, Column 1: [Suggestion-column-header-missing] Column headers are required for tables. Add appropriate header text. NOTE: This Suggestion will become a Warning on 1/29/21.

dotnet/xml/Microsoft.Toolkit.Uwp.UI.Controls/BackButtonBehavior.xml

  • Line 0, Column 0: [Warning-ECMA2Yaml_Enum_NoRemarks] Please note: <remarks> node on Enum fields will be ignored.
  • Line 0, Column 0: [Warning-ECMA2Yaml_Enum_NoRemarks] Please note: <remarks> node on Enum fields will be ignored.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Core.SystemNavigationManager'.

dotnet/xml/Microsoft.Toolkit.Win32.UI.Controls.Interop.WinRT/WebViewControlPermissionType.xml

  • Line 0, Column 0: [Warning-ECMA2Yaml_Enum_NoRemarks] Please note: <remarks> node on Enum fields will be ignored.
  • Line 0, Column 0: [Warning-ECMA2Yaml_Enum_NoRemarks] Please note: <remarks> node on Enum fields will be ignored.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.Web.UI.WebViewControlPermissionType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.Web.UI.WebViewControlPermissionType'.

dotnet/xml/Microsoft.Toolkit.Uwp.UI.Lottie/LottieVisualSource.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.Foundation.TypedEventHandler`2'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Microsoft.UI.Xaml.Controls.IDynamicAnimatedVisualSource'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Microsoft.UI.Xaml.Controls.IDynamicAnimatedVisualSource.AnimatedVisualInvalidated'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.Foundation.IStringable.ToString'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.Foundation.IAsyncAction'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.Foundation.Uri'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.Foundation.Metadata.OverloadAttribute'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.Foundation.IAsyncAction'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.Storage.StorageFile'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.Foundation.Metadata.DefaultOverloadAttribute'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.Foundation.Metadata.OverloadAttribute'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Microsoft.UI.Xaml.Controls.IAnimatedVisualSource'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Microsoft.UI.Xaml.Controls.IDynamicAnimatedVisualSource'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.Foundation.IStringable'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyObject'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.Foundation.Metadata.ActivatableAttribute'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.Foundation.Metadata.MarshalingBehaviorAttribute'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.Foundation.Metadata.StaticAttribute'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.Foundation.Metadata.ThreadingAttribute'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.Foundation.Metadata.VersionAttribute'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Microsoft.UI.Xaml.Controls.IAnimatedVisual'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Composition.Compositor'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Microsoft.UI.Xaml.Controls.IAnimatedVisualSource.TryCreateAnimatedVisual(Windows.UI.Composition.Compositor,System.Object@)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.Foundation.IStringable.ToString'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.Storage.StorageFile'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.Foundation.Uri'.

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:

@Kyaa-dost Kyaa-dost marked this pull request as ready for review March 3, 2021 20:48
@Kyaa-dost
Copy link
Contributor

@michael-hawker opening this for review as the PR was merged in the main repo

Copy link
Contributor

@Kyaa-dost Kyaa-dost left a comment

Choose a reason for hiding this comment

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

@ratishphilip Thanks for the doc. Overall, it looks great! Just some minor typos and if you can add the squircle image/gif in the file for the demo that would be great.

@opbld30
Copy link

opbld30 commented Mar 3, 2021

Docs Build status updates of commit 1873df0:

⚠️ Validation status: warnings

File Status Preview URL Details
docs/parsers/CanvasPathGeometry.md ⚠️Warning View Details
docs/parsers/Win2d_Path_Mini_Language.md ⚠️Warning View Details
docs/resources/images/Squircle.gif ✅Succeeded View
docs/toc.md ✅Succeeded View

docs/parsers/CanvasPathGeometry.md

  • Line 2, Column 1: [Warning-title-missing] Missing required attribute: 'title'. Add a title string to show in search engine results.
  • Line 40, Column 1: [Warning-invalid-note-section] Text in the first line of Note/Section/Video is not valid. Will be rendered to <blockquote>
  • Line 46, Column 287: [Warning-insecure-link] Link 'http://aka.ms/uwptoolkitapp' is insecure. Links to Microsoft sites must use 'https' instead of 'http'.
  • Line 4, Column 14: [Suggestion-duplicate-descriptions] Attribute 'description' with value 'describe your control in one sentence' is duplicated in 'parsers/CanvasPathGeometry.md(4,14)', 'parsers/Win2d_Path_Mini_Language.md(4,14)'.

docs/parsers/Win2d_Path_Mini_Language.md

  • Line 2, Column 1: [Warning-title-missing] Missing required attribute: 'title'. Add a title string to show in search engine results.
  • Line 63, Column 1: [Warning-h1-not-first] Markdown content is not allowed before H1 'Introduction'.
  • Line 96, Column 1: [Warning-multiple-h1s] Multiple H1s(H1 'Win2d Path Mini Language') are not allowed. You can only have one top-level heading.
  • Line 868, Column 1: [Warning-multiple-h1s] Multiple H1s(H1 'Creating Geometries, Brushes, Strokes and StrokeStyles') are not allowed. You can only have one top-level heading.
  • Line 4, Column 14: [Suggestion-duplicate-descriptions] Attribute 'description' with value 'describe your control in one sentence' is duplicated in 'parsers/CanvasPathGeometry.md(4,14)', 'parsers/Win2d_Path_Mini_Language.md(4,14)'.

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:

CanvasGeometry triangleGeometry = CanvasPathGeometry.CreateGeometry(device, pathData);
```

> [!div class="nextstepaction"][try it in the sample app](uwpct://Helpers?sample=CanvasPathGeometryPage)
Copy link
Collaborator

Choose a reason for hiding this comment

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

This has to be two lines like in the template.

Comment on lines +42 to +57
## Sample Project

<!-- Link to the sample page in the Windows Community Toolkit Sample App -->

[CanvasPathGeometry Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/master/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/CanvasPathGeometry/CanvasPathGeometryPage.xaml.cs). You can [see this in action](uwpct://Helpers?sample=CanvasPathGeometryPage) in [Windows Community Toolkit Sample App](http://aka.ms/uwptoolkitapp).

## Requirements

| Device family | Universal, MinVersion or higher |
| ------------- | ------------------------------------------------------------------------------------------------ |
| Namespace | Microsoft.Toolkit.Uwp.UI.Media.Geometry |
| NuGet package | [Microsoft.Toolkit.Uwp.UI.Media](https://www.nuget.org/packages/Microsoft.Toolkit.Uwp.UI.Media/) |

## API

- [CanvasPathGeometry](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/master/Microsoft.Toolkit.Uwp.UI.Media/Geometry/CanvasPathGeometry.cs)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should keep these things at the bottom, and probably just move all the examples up under an 'Examples' section.

- csharp
---

- [Introduction](#introduction)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Think this TOC should go after the Intro.

- [ICanvasStroke interface and CanvasStroke class](#icanvasstroke-interface-and-canvasstroke-class)
- [Creating Geometries, Brushes, Strokes and StrokeStyles](#creating-geometries-brushes-strokes-and-strokestyles)

# Introduction
Copy link
Collaborator

Choose a reason for hiding this comment

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

You can't have multiple top-level headings, be sure to check the warnings from the build comment.

docs/toc.md Outdated
Comment on lines 177 to 181
# Parsers
## [MarkdownParser](parsers/MarkdownParser.md)
## [RSSParser](parsers/RSSParser.md)
## [Win2d Path Mini Language Parser](parsers/CanvasPathGeometry.md)
## [Win2d Path Mini Language](parsers/Win2d_Path_Mini_Language.md)
Copy link
Collaborator

Choose a reason for hiding this comment

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

We may just want to put these under Helpers for now or rename Brushes to Media. @Sergio0694 did we need to docs for new VisualEffects Factory stuff somewhere?

Copy link
Contributor

Choose a reason for hiding this comment

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

We have that in a sample page but don't think we have that in the actual docs yet. I can make a PR to add a page with a small example to showcase how to use it though 🙂

@Kyaa-dost
Copy link
Contributor

@michael-hawker I think there is this serious confusion going on with the current toc Vs conflict with these files and the author branches. It's because a lot of these PR's go all the way back to 2020. I will have to fix the toc file here with the updated one.

@opbld30
Copy link

opbld30 commented Mar 4, 2021

Docs Build status updates of commit 335dc12:

⚠️ Validation status: warnings

File Status Preview URL Details
docs/parsers/CanvasPathGeometry.md ⚠️Warning View Details
docs/parsers/Win2d_Path_Mini_Language.md ⚠️Warning View Details
docs/resources/images/Squircle.gif ✅Succeeded View
docs/toc.md ✅Succeeded View

docs/parsers/CanvasPathGeometry.md

  • Line 2, Column 1: [Warning-title-missing] Missing required attribute: 'title'. Add a title string to show in search engine results.
  • Line 40, Column 1: [Warning-invalid-note-section] Text in the first line of Note/Section/Video is not valid. Will be rendered to <blockquote>
  • Line 46, Column 287: [Warning-insecure-link] Link 'http://aka.ms/uwptoolkitapp' is insecure. Links to Microsoft sites must use 'https' instead of 'http'.
  • Line 4, Column 14: [Suggestion-duplicate-descriptions] Attribute 'description' with value 'describe your control in one sentence' is duplicated in 'parsers/CanvasPathGeometry.md(4,14)', 'parsers/Win2d_Path_Mini_Language.md(4,14)'.

docs/parsers/Win2d_Path_Mini_Language.md

  • Line 2, Column 1: [Warning-title-missing] Missing required attribute: 'title'. Add a title string to show in search engine results.
  • Line 63, Column 1: [Warning-h1-not-first] Markdown content is not allowed before H1 'Introduction'.
  • Line 96, Column 1: [Warning-multiple-h1s] Multiple H1s(H1 'Win2d Path Mini Language') are not allowed. You can only have one top-level heading.
  • Line 868, Column 1: [Warning-multiple-h1s] Multiple H1s(H1 'Creating Geometries, Brushes, Strokes and StrokeStyles') are not allowed. You can only have one top-level heading.
  • Line 4, Column 14: [Suggestion-duplicate-descriptions] Attribute 'description' with value 'describe your control in one sentence' is duplicated in 'parsers/CanvasPathGeometry.md(4,14)', 'parsers/Win2d_Path_Mini_Language.md(4,14)'.

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:

@michael-hawker
Copy link
Collaborator

Thanks @Kyaa-dost for the clarification. I'd like to revamp our TOC before the release anyway, so we can go through it together next week before we push new docs up.

@opbld32
Copy link

opbld32 commented Mar 5, 2021

Docs Build status updates of commit bc846de:

⚠️ Validation status: warnings

File Status Preview URL Details
docs/parsers/CanvasPathGeometry.md ⚠️Warning View Details
docs/parsers/Win2d_Path_Mini_Language.md ⚠️Warning View Details
docs/extensions/StringExtensions.md ⚠️Warning View Details
docs/Toolbox-Support.md ⚠️Warning View Details
docs/resources/images/Squircle.gif ✅Succeeded View
docs/toc.md ✅Succeeded View

docs/parsers/CanvasPathGeometry.md

  • Line 2, Column 1: [Warning-title-missing] Missing required attribute: 'title'. Add a title string to show in search engine results.
  • Line 40, Column 1: [Warning-invalid-note-section] Text in the first line of Note/Section/Video is not valid. Will be rendered to <blockquote>
  • Line 46, Column 287: [Warning-insecure-link] Link 'http://aka.ms/uwptoolkitapp' is insecure. Links to Microsoft sites must use 'https' instead of 'http'.
  • Line 4, Column 14: [Suggestion-duplicate-descriptions] Attribute 'description' with value 'describe your control in one sentence' is duplicated in 'parsers/CanvasPathGeometry.md(4,14)', 'parsers/Win2d_Path_Mini_Language.md(4,14)'.

docs/parsers/Win2d_Path_Mini_Language.md

  • Line 2, Column 1: [Warning-title-missing] Missing required attribute: 'title'. Add a title string to show in search engine results.
  • Line 63, Column 1: [Warning-h1-not-first] Markdown content is not allowed before H1 'Introduction'.
  • Line 96, Column 1: [Warning-multiple-h1s] Multiple H1s(H1 'Win2d Path Mini Language') are not allowed. You can only have one top-level heading.
  • Line 868, Column 1: [Warning-multiple-h1s] Multiple H1s(H1 'Creating Geometries, Brushes, Strokes and StrokeStyles') are not allowed. You can only have one top-level heading.
  • Line 4, Column 14: [Suggestion-duplicate-descriptions] Attribute 'description' with value 'describe your control in one sentence' is duplicated in 'parsers/CanvasPathGeometry.md(4,14)', 'parsers/Win2d_Path_Mini_Language.md(4,14)'.

docs/extensions/StringExtensions.md

  • Line 0, Column 0: [Warning-h1-missing] H1 is required. Use a single hash (#) followed by a space to create your top-level heading.

docs/Toolbox-Support.md

  • Line 11, Column 1: [Warning-h1-not-first] Markdown content is not allowed before H1 'Adding the Windows Community Toolkit to your Visual Studio Toolbox (for version 2.0 or below)'.

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:

Co-authored-by: Kyaa Dost <35208324+Kyaa-dost@users.noreply.github.com>
@opbld32
Copy link

opbld32 commented Mar 9, 2021

Docs Build status updates of commit 308db31:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
❌Error Details

  • [Error-PullRequestMergeConflict] Cannot sync git repo to specified state. Please make sure the pull request is mergeable.

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:

@opbld31
Copy link

opbld31 commented Mar 9, 2021

Docs Build status updates of commit 51d4b85:

⚠️ Validation status: warnings

File Status Preview URL Details
docs/parsers/CanvasPathGeometry.md ⚠️Warning View Details
docs/parsers/Win2d_Path_Mini_Language.md ⚠️Warning View Details
docs/resources/images/Squircle.gif ✅Succeeded View

docs/parsers/CanvasPathGeometry.md

  • Line 2, Column 1: [Warning-title-missing] Missing required attribute: 'title'. Add a title string to show in search engine results.
  • Line 40, Column 1: [Warning-invalid-note-section] Text in the first line of Note/Section/Video is not valid. Will be rendered to <blockquote>
  • Line 46, Column 287: [Warning-insecure-link] Link 'http://aka.ms/uwptoolkitapp' is insecure. Links to Microsoft sites must use 'https' instead of 'http'.
  • Line 4, Column 14: [Suggestion-duplicate-descriptions] Attribute 'description' with value 'describe your control in one sentence' is duplicated in 'parsers/CanvasPathGeometry.md(4,14)', 'parsers/Win2d_Path_Mini_Language.md(4,14)'.

docs/parsers/Win2d_Path_Mini_Language.md

  • Line 2, Column 1: [Warning-title-missing] Missing required attribute: 'title'. Add a title string to show in search engine results.
  • Line 63, Column 1: [Warning-h1-not-first] Markdown content is not allowed before H1 'Introduction'.
  • Line 96, Column 1: [Warning-multiple-h1s] Multiple H1s(H1 'Win2d Path Mini Language') are not allowed. You can only have one top-level heading.
  • Line 868, Column 1: [Warning-multiple-h1s] Multiple H1s(H1 'Creating Geometries, Brushes, Strokes and StrokeStyles') are not allowed. You can only have one top-level heading.
  • Line 4, Column 14: [Suggestion-duplicate-descriptions] Attribute 'description' with value 'describe your control in one sentence' is duplicated in 'parsers/CanvasPathGeometry.md(4,14)', 'parsers/Win2d_Path_Mini_Language.md(4,14)'.

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:

@michael-hawker
Copy link
Collaborator

Rebasing to avoid merge conflicts and finishing applying linter updates in #469 so we can finalize docs. Thanks @ratishphilip!

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants