Skip to content

Commit ff1cf98

Browse files
committed
chore(creating-ps-pester-tests): Improve wording
Co-authored-by: Agnès ZITTE <16295702+agneszitte@users.noreply.github.com> docs(check_toc): Added documentation to commit 1828cff including troubleshooting gif chore(creating-ps-pester-tests): Improve wording Co-authored-by: Agnès ZITTE <16295702+agneszitte@users.noreply.github.com> chore: applied xref links chore: Fix Title Missing and fix markdownlint chore: applied xref links
1 parent d2b881e commit ff1cf98

File tree

8 files changed

+26
-24
lines changed

8 files changed

+26
-24
lines changed

doc/articles/check-toc-utilities/Overview.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
22
uid: Uno.Contributing.check-toc.Overview
33
---
4+
# Overview
45

5-
# Toc Checker Overview
6-
7-
The `check_toc.ps1` script helps maintain the structure and integrity of your documentation by:
6+
The [`check_toc.ps1`](../check_toc.ps1) script helps maintain the structure and integrity of your documentation by:
87

98
- Detecting **broken links** in [toc.yml](../toc.yml)
109
- Identifying **Markdown files** recursive to `articles` folder that are **not referenced** in the TOC
@@ -16,7 +15,7 @@ The `check_toc.ps1` script helps maintain the structure and integrity of your do
1615
## 🛠️ Usage
1716

1817
1. Open a **PowerShell terminal** at the **root** of your locally cloned Uno repository.
19-
2. Navigate to the `doc/articles` directory:
18+
2. Navigate to the [`doc/articles`](../../articles/) directory:
2019

2120
```ps1
2221
cd doc/articles
@@ -57,4 +56,4 @@ Utility functions are dynamically imported from [`Import-TocCheckerUtils.ps1`](.
5756

5857
## 🌐 Further Reading
5958

60-
- [!INCLUDE [Clean Architecture Principles Inline](../includes/clean-architecture-principles-inline.md)]
59+
- [!INCLUDE [Clean Architecture Principles Inline](xref:Uno.Clean-Architecture-Inline)]

doc/articles/check-toc-utilities/Utilities.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ uid: Uno.Contributing.check-toc.Utilities
55

66
*[SoC]: Separation of Concerns – Part of Clean Architecture
77

8-
The utility functions used by the `check_toc.ps1` script follow SoC principles to improve modularity, maintainability, and testability. These helpers are dynamically imported during script execution via the [`Import-TocCheckerUtils.ps1`](../check-toc-utilities/Import-TocCheckerUtils.ps1) script and encapsulate common logic such as file enumeration, header parsing, and output generation.
8+
The utility functions used by the `check_toc.ps1` script follow SoC principles to improve modularity, maintainability, and testability. These helpers are dynamically imported during script execution via the [`Import-TocCheckerUtils.ps1`](./Import-TocCheckerUtils.ps1) script and encapsulate common logic such as file enumeration, header parsing, and output generation.
99

1010
> [!TIP]
1111
> Keeping utility functions well-documented and separated from the main script logic helps contributors understand, maintain, and extend the tooling efficiently.

doc/articles/contributing/Documentation/docfx.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,4 +178,4 @@ To run the script on Windows:
178178

179179
## Import Uno Extensions and Tools docs
180180

181-
[!INCLUDE ../external/ <!--https://github.com/unoplatform/uno.extensions/blob/main/doc/README.md -->]
181+
[!INCLUDE [Import external docs](../../external/uno.extensions/doc/README.md)]

doc/articles/contributing/guidelines/creating-ps-pester-tests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ uid: Uno.Contributing.Scripts.PowerShell-Pester-Tests
66

77
## Introduction
88

9-
Some Parts of Uno.UI like the [Toc Checker](xref:Uno.Contributing.check-toc.Overview) with its [Utility Functions](xref:Uno.Contributing.check-toc.Utilities) are written in PowerShell. To make sure, they are working properly, the recommended and most common used Testing Framework is [Pester](https://pester.dev/docs/quick-start).
9+
Some Parts of Uno.UI like the [Toc Checker](xref:Uno.Contributing.check-toc.Overview) with its [Utility Functions](xref:Uno.Contributing.check-toc.Utilities) are written in PowerShell. To make sure they are working properly, the recommended and most commonly used Testing Framework is [Pester](https://pester.dev/docs/quick-start).
1010

1111
<!-- ### TODO: ## Installing Pester 5+ https://pester.dev/docs/introduction/installation -->
1212

doc/articles/guides/how-to-create-control-libraries.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ In a Control Class Library, [conditional XAML](xref:Uno.Development.PlatformSpec
105105

106106
## Library assets
107107

108-
WinUI 3 and Uno Platform (4.6 and later) Libraries support the inclusion of content assets to be used with [`StorageFile.GetFileFromApplicationUriAsync`](../features/file-management.md#support-for-storagefilegetfilefromapplicationuriasync), as well as with the `ms-appx:///[libraryname]/[assetname_file_name]` format.
108+
WinUI 3 and Uno Platform (4.6 and later) Libraries support the inclusion of content assets to be used with [`StorageFile.GetFileFromApplicationUriAsync`](xref:Uno.Features.FileManagement#support-for-storagefilegetfilefromapplicationuriasync), as well as with the `ms-appx:///[libraryname]/[assetname_file_name]` format.
109109

110110
> [!IMPORTANT]
111111
> When using library assets with non-WinAppSDK targets, the library name should also be lower cased.
@@ -126,7 +126,7 @@ In both cases, for the build system to include the assets files, the following p
126126
```
127127

128128
> [!IMPORTANT]
129-
> WinAppSDK [does not support assets](https://github.com/microsoft/microsoft-ui-xaml/issues/6429) if the application is using the MSIX package mode. To use the unpackaged mode, [see this article](../features/winapp-sdk-specifics.md#unpackaged-application-support).
129+
> WinAppSDK [does not support assets](https://github.com/microsoft/microsoft-ui-xaml/issues/6429) if the application is using the MSIX package mode. To use the unpackaged mode, [see this article](xref:Uno.Features.WinAppSDK#un-packaged-application-support).
130130
131131
## Considerations for the Skia Renderer
132132

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
1+
---
2+
uid: Uno.Clean-Architecture-Inline
3+
---
14
<!-- markdownlint-disable MD041-->
25
[Clean Architecture principles](https://devblogs.microsoft.com/ise/next-level-clean-architecture-boilerplate)

doc/articles/toc.yml

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@
165165
- name: Working with Skia Desktop
166166
href: xref:Uno.Skia.Desktop
167167
- name: Working with the Linux Framebuffer
168-
href: features/using-linux-framebuffer.md
168+
href: xref:Uno.Skia.Linux.Framebuffer
169169
- name: Philosophy
170170
href: xref:Uno.Overview.Philosophy
171171
- name: How Uno Works
@@ -192,9 +192,9 @@
192192
- name: Creating Custom Controls
193193
href: guides/creating-custom-controls.md
194194
- name: Control Libraries
195-
href: guides/how-to-create-control-libraries.md
195+
href: xref:Guide.HowTo.Create-Control-Library
196196
- name: Adding New Platforms
197-
href: guides/how-to-add-platforms-existing-project.md
197+
href: xref:Uno.Guides.AddAdditionalPlatforms
198198
- name: Using the Skia Desktop
199199
href: xref:Uno.Skia.Desktop
200200
- name: Linux Framebuffer
@@ -322,9 +322,9 @@
322322
- name: IL Linker for WebAssembly
323323
href: xref:uno.articles.features.illinker
324324
- name: Working with String Resource Trimming
325-
href: features/upri-trimming.md
325+
href: xref:Uno.Features.StringResourceTrimming
326326
- name: Working with XAML Trimming
327-
href: features/resources-trimming.md
327+
href: xref:Uno.Features.ResourcesTrimming
328328
- name: Error Monitoring & Crash Reporting with Raygun
329329
href: xref:Monitoring.Raygun
330330

@@ -365,7 +365,7 @@
365365
- name: Guidelines for Contributing Documentation
366366
items:
367367
- name: Adding documentation
368-
href: uno-development/doc-on-docs.md
368+
href: xref:Uno.Contributing.Docs
369369
- name: DocFX
370370
href: xref:Uno.Contributing.DocFx
371371
- name: Toc Checker
@@ -481,7 +481,7 @@
481481
- name: Uno and WinUI 3
482482
href: uwp-vs-winui3.md
483483
- name: WinAppSDK Specifics
484-
href: features/winapp-sdk-specifics.md
484+
href: xref:Uno.Features.WinAppSDK
485485
- name: WinUI links
486486
items:
487487
- name: Overview
@@ -507,19 +507,19 @@
507507
- name: Activities in Android
508508
href: android-activities.md
509509
- name: ComboBox
510-
href: controls/ComboBox.md
510+
href: xref:Uno.Controls.ComboBox
511511
- name: CommandBar
512-
href: controls/CommandBar.md
512+
href: xref:Uno.Controls.CommandBar
513513
- name: DatePicker
514-
href: controls/DatePicker.md
514+
href: xref:Uno.Controls.DatePicker
515515
- name: ElevatedView
516-
href: features/ElevatedView.md
516+
href: xref:Uno.Features.ElevatedView
517517
- name: Fluent icon font
518-
href: uno-fluent-assets.md
518+
href: xref:Uno.Development.FluentAssets
519519
- name: Flyout
520-
href: controls/Flyout.md
520+
href: xref:Uno.Controls.Flyout
521521
- name: Frame
522-
href: controls/Frame.md
522+
href: xref:Uno.Controls.Frame
523523
- name: GLCanvasElement
524524
href: xref:Uno.Controls.GLCanvasElement
525525
- name: Image
475 KB
Loading

0 commit comments

Comments
 (0)