v1.0.3

🩹 [Patch]: Update to use Microsoft.PowerShell.PlatyPS for docs generation (#19)

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.

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