Context
PowerShell functions can have an online help URL configured so that Get-Help <FunctionName> -Online opens the documentation in a browser. The PSModule framework generates documentation sites but does not automatically set the online help URI in functions.
Request
The Build or Document step should update functions with links to their online help pages, enabling Get-Help <FunctionName> -Online to point to the generated documentation site.
Acceptance criteria
- Each public function has a
.LINK entry pointing to its online documentation page Get-Help <FunctionName> -Online opens the correct documentation URL- The URL is based on the module's documentation site and function name
Technical decisions
To be determined during implementation planning — evaluate whether to set HelpUri in [CmdletBinding()] or add .LINK entries during build.
Implementation plan
Context
PowerShell functions can have an online help URL configured so that
Get-Help <FunctionName> -Onlineopens the documentation in a browser. The PSModule framework generates documentation sites but does not automatically set the online help URI in functions.Request
The Build or Document step should update functions with links to their online help pages, enabling
Get-Help <FunctionName> -Onlineto point to the generated documentation site.Acceptance criteria
.LINKentry pointing to its online documentation pageGet-Help <FunctionName> -Onlineopens the correct documentation URLTechnical decisions
To be determined during implementation planning — evaluate whether to set
HelpUriin[CmdletBinding()]or add.LINKentries during build.Implementation plan
Get-Help -Onlinefor multiple functions