Skip to content

Commit d2b881e

Browse files
committed
docs(check-toc): Added check-toc utils documentation, not finished yet
1 parent b53ed85 commit d2b881e

File tree

2 files changed

+29
-2
lines changed

2 files changed

+29
-2
lines changed

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

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

6-
The [`check_toc.ps1`](../check_toc.ps1) script helps maintain the structure and integrity of your documentation by:
7+
The `check_toc.ps1` script helps maintain the structure and integrity of your documentation by:
78

89
- Detecting **broken links** in [toc.yml](../toc.yml)
910
- Identifying **Markdown files** recursive to `articles` folder that are **not referenced** in the TOC
@@ -15,7 +16,7 @@ The [`check_toc.ps1`](../check_toc.ps1) script helps maintain the structure and
1516
## 🛠️ Usage
1617

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

2021
```ps1
2122
cd doc/articles
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
uid: Uno.Contributing.Scripts.PowerShell-Pester-Tests
3+
---
4+
5+
# Testing PowerShell Scripts with Pester
6+
7+
## Introduction
8+
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).
10+
11+
<!-- ### TODO: ## Installing Pester 5+ https://pester.dev/docs/introduction/installation -->
12+
13+
<!-- TODO: ### Pester List of the Commonly used Commands -->
14+
<!-- TODO: ### Mocking File Content to test with Pester (like uid:) -->
15+
16+
## Showing Pester Test Result in CI
17+
18+
Pester integrates seamlessly with CI pipelines, allowing you to automate the validation of your PowerShell scripts. By including Pester tests in your CI configuration, you can ensure that changes to the `check_toc.ps1` script or its utilities do not introduce regressions. Most CI systems, such as GitHub Actions or Azure Pipelines, support running Pester tests and can display detailed test results in their interfaces.
19+
20+
For more information, refer to the [Pester Test Results Documentation](https://pester.dev/docs/usage/test-results).
21+
22+
## 📄 Related Pages
23+
24+
- [The Uno docs website and DocFX](xref:Uno.Contributing.DocFx)
25+
- [Validating the Table of Contents](xref:Uno.Contributing.check-toc.Overview)
26+
- [Utility Functions for `check_toc`](xref:Uno.Contributing.check-toc.Utilities)

0 commit comments

Comments
 (0)