Skip to content

Commit 5330b6a

Browse files
authored
Add docs verifier check (#2188)
* Add markdown-links-verifier-config.json file * Add MSDocs build verifier workflow * Hide .github folder from docs validation Add step to hide .github folder before validation * Fix links * Update readme
1 parent b18811e commit 5330b6a

31 files changed

+68
-31
lines changed
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: MSDocs build verifier
2+
on: pull_request
3+
4+
permissions:
5+
contents: read
6+
7+
env:
8+
GITHUB_PR_NUMBER: ${{ github.event.pull_request.number }}
9+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
10+
11+
jobs:
12+
validate:
13+
name: MSDocs build verifier
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Harden Runner
17+
uses: step-security/harden-runner@e3f713f2d8f53843e71c69a996d56f51aa9adfb9 # v2.14.1
18+
with:
19+
egress-policy: audit
20+
21+
- name: Checkout the repository
22+
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
23+
24+
- name: Hide .github folder from validate
25+
run: |
26+
rm -rf "${{ github.workspace }}/.github"
27+
28+
- name: Validate
29+
uses: dotnet/docs-actions/actions/docs-verifier@5e8bcc78465d45a7544bba56509a1a69922b6a5a # main

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This repository contains the conceptual documentation for .NET desktop technolog
88

99
We have a large community using these resources. We make our best effort to respond to issues in a timely fashion. You can read more about our procedures for classifying and resolving issues in our [Issues policy](issues-policy.md) topic.
1010

11-
We welcome contributions to help us improve and complete the .NET docs. This is a very large repo, covering a large area. If this is your first visit, see our [labels and projects roadmap](styleguide/labels-projects.md) for help navigating the issues and projects in this repository.
11+
We welcome contributions to help us improve and complete the .NET docs.
1212

1313
## Migrate old examples
1414

dotnet-desktop-guide/winforms/forms/events.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ When you need to update UI controls from background threads within async operati
106106

107107
# [.NET](#tab/dotnet)
108108

109-
.NET 9 introduced <xref:System.Windows.Forms.Control.InvokeAsync%2A?displayProperty=nameWithType>, which provides async-friendly marshaling to the UI thread. Unlike `Control.Invoke` which **sends** (blocks the calling thread), `Control.InvokeAsync` **posts** (non-blocking) to the UI thread's message queue. For more information about `Control.InvokeAsync`, see [How to make thread-safe calls to controls](../controls/how-to-make-thread-safe-calls.md#).
109+
.NET 9 introduced <xref:System.Windows.Forms.Control.InvokeAsync%2A?displayProperty=nameWithType>, which provides async-friendly marshaling to the UI thread. Unlike `Control.Invoke` which **sends** (blocks the calling thread), `Control.InvokeAsync` **posts** (non-blocking) to the UI thread's message queue. For more information about `Control.InvokeAsync`, see [How to make thread-safe calls to controls](../controls/how-to-make-thread-safe-calls.md).
110110

111111
**Key advantages of InvokeAsync:**
112112

dotnet-desktop-guide/wpf/advanced/annotations-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Another example scenario involves applications that enable the exchange of annot
7979
- <xref:System.Windows.Controls.FlowDocumentReader>
8080
- <xref:System.Windows.Annotations.IAnchorInfo>
8181
- [Annotations Schema](annotations-schema.md)
82-
- [ContextMenu Overview](../controls/contextmenu-overview.md)
82+
- [ContextMenu Overview](../controls/contextmenu.md)
8383
- [Commanding Overview](commanding-overview.md)
8484
- [Flow Document Overview](flow-document-overview.md)
8585
- [How to: Add a Command to a MenuItem](/previous-versions/dotnet/netframework-3.5/ms741839(v=vs.90))

dotnet-desktop-guide/wpf/advanced/hosting-win32-content-in-wpf.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -365,7 +365,7 @@ public partial class Window1 : Window {
365365

366366
Which gives you:
367367

368-
![Screenshot of the WPF app running.](./media/hosting-win32-content-in-wpf/windows-presentation-foundation-application.png)
368+
![Screenshot of the WPF app running.](./media/hosting-win32-content-in-wpf/windows-presentation-foundation-application.PNG)
369369

370370
## See also
371371

dotnet-desktop-guide/wpf/advanced/how-to-handle-the-contextmenuopening-event.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,4 +61,4 @@ The final scenario, writing a handler that suppresses a menu totally, is uncommo
6161
- <xref:System.Windows.Controls.ContextMenu>
6262
- <xref:System.Windows.FrameworkElement.ContextMenu%2A?displayProperty=nameWithType>
6363
- [Base Elements Overview](base-elements-overview.md)
64-
- [ContextMenu Overview](../controls/contextmenu-overview.md)
64+
- [ContextMenu Overview](../controls/contextmenu.md)

dotnet-desktop-guide/wpf/advanced/how-to-use-a-thicknessconverter-object.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,4 @@ This example does not run.
3232
- <xref:System.Windows.Controls.Border>
3333
- [How to: Change the Margin Property](/previous-versions/dotnet/netframework-3.5/ms750561(v=vs.90))
3434
- [How to: Convert a ListBoxItem to a new Data Type](/previous-versions/dotnet/netframework-3.5/ms749147(v=vs.90))
35-
- [Panels Overview](../controls/panels-overview.md)
35+
- [Panels Overview](../controls/panel.md)

dotnet-desktop-guide/wpf/advanced/layout.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,12 +159,12 @@ Layout rounding is disabled by default. To enable layout rounding, set the <xref
159159

160160
## What's Next
161161

162-
Understanding how elements are measured and arranged is the first step in understanding layout. For more information about the available <xref:System.Windows.Controls.Panel> elements, see [Panels Overview](../controls/panels-overview.md). To better understand the various positioning properties that can affect layout, see [Alignment, Margins, and Padding Overview](alignment-margins-and-padding-overview.md). When you are ready to put it all together in a lightweight application, see [Walkthrough: My first WPF desktop application](../get-started/walkthrough-my-first-wpf-desktop-application.md).
162+
Understanding how elements are measured and arranged is the first step in understanding layout. For more information about the available <xref:System.Windows.Controls.Panel> elements, see [Panels Overview](../controls/panel.md). To better understand the various positioning properties that can affect layout, see [Alignment, Margins, and Padding Overview](alignment-margins-and-padding-overview.md). When you are ready to put it all together in a lightweight application, see [Walkthrough: My first WPF desktop application](../get-started/walkthrough-my-first-wpf-desktop-application.md).
163163

164164
## See also
165165

166166
- <xref:System.Windows.FrameworkElement>
167167
- <xref:System.Windows.UIElement>
168-
- [Panels Overview](../controls/panels-overview.md)
168+
- [Panels Overview](../controls/panel.md)
169169
- [Alignment, Margins, and Padding Overview](alignment-margins-and-padding-overview.md)
170170
- [Layout and Design](optimizing-performance-layout-and-design.md)

dotnet-desktop-guide/wpf/advanced/optimizing-performance-layout-and-design.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ The layout pass process is invoked again if any of the following actions occur:
4949

5050
The complexity of the layout process is directly based on the layout behavior of the <xref:System.Windows.Controls.Panel>-derived elements you use. For example, a <xref:System.Windows.Controls.Grid> or <xref:System.Windows.Controls.StackPanel> control provides much more functionality than a <xref:System.Windows.Controls.Canvas> control. The price for this greater increase in functionality is a greater increase in performance costs. However, if you do not require the functionality that a <xref:System.Windows.Controls.Grid> control provides, you should use the less costly alternatives, such as a <xref:System.Windows.Controls.Canvas> or a custom panel.
5151

52-
For more information, see [Panels Overview](../controls/panels-overview.md).
52+
For more information, see [Panels Overview](../controls/panel.md).
5353

5454
### Update Rather than Replace a RenderTransform
5555

dotnet-desktop-guide/wpf/advanced/use-automatic-layout-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Using the automatic layout approach requires a set of coding and design standard
5757

5858
- Use <xref:System.Windows.Controls.DockPanel>, <xref:System.Windows.Controls.StackPanel>, and <xref:System.Windows.Controls.Grid> to position controls.
5959

60-
For a discussion about various types of panels, see [Panels Overview](../controls/panels-overview.md).
60+
For a discussion about various types of panels, see [Panels Overview](../controls/panel.md).
6161

6262
**Do not set a fixed size for a window**
6363

0 commit comments

Comments
 (0)