🩹 [Patch]: Update to use Microsoft.PowerShell.PlatyPS for docs generation

[MariusStorhaug]

Description

This pull request introduces several improvements to the documentation generation process, CI workflows, and PowerShell module metadata. The most significant changes include enhanced and more robust documentation generation, updates to GitHub Actions workflows for better security and linting, and improvements to module help comments for consistency.

• Fixes 🚀[Feature]: Generate documentation with Microsoft.PowerShell.PlatyPS Process-PSModule#103
• Fixes 🩹 [Patch]: Upgrade to Microsoft.PowerShell.PlatyPS 1.0.0 Process-PSModule#180
• Fixes 🪲[Bug]: Build-Docs - Complain about trailing spaces Process-PSModule#219

Documentation generation improvements:

• The Build-PSModuleDocumentation.ps1 script now generates markdown help per command, handles documentation file organization to match source structure, and fixes frontmatter titles for compatibility. This makes the documentation process more robust and the output more consistent. [1] [2]
• The script now uses the full module name Microsoft.PowerShell.PlatyPS for installation, ensuring compatibility.

GitHub Actions workflow enhancements:

• The Action-Test.yml workflow now requests explicit permissions for reading contents and writing statuses, uses a full-depth fetch for checkouts, logs file changes, commits documentation updates, and adds a markdown linter step. [1] [2] [3]
• The Linter.yml workflow disables certain linters for performance and disables credential persistence for increased security. [1] [2]

PowerShell module metadata improvements:

• Added .DESCRIPTION sections to all module functions for better help output, and added .NOTES with control instructions to Set-PSModuleTest and its corresponding public function. [1] [2] [3] [4] [5]

Link: https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.platyps/new-markdowncommandhelp?view=ps-modules

[Copilot]

Pull Request Overview

This PR updates documentation generation to use the newer Microsoft.PowerShell.PlatyPS module instead of the legacy PlatyPS module. The change adds control documentation to a PowerShell function's help block.

• Added control documentation section to PowerShell function help

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[Copilot]

Pull Request Overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[Copilot]

Pull Request Overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[Copilot]

Pull Request Overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[Copilot]

Pull Request Overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[Copilot]

Pull Request Overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[Copilot]

Pull Request Overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[Copilot]

Pull Request Overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[Copilot]

Pull Request Overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[Copilot]

Pull Request Overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[Copilot]

Pull Request Overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated no new comments.

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[Copilot]

Pull Request Overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated no new comments.

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[Copilot]

Pull Request Overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated no new comments.

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[Copilot]

Pull Request Overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[Copilot]

The variable $moduleDocsFolder is calculated twice (lines 115 and 141) with the same logic. Consider calculating it once at the beginning of the function to avoid code duplication.