Skip to content

Set online help URI for functions pointing to documentation site #36

Description

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

  • Determine the URL pattern for function help pages on the documentation site
  • Add the online help URI to each public function during the build step
  • Test Get-Help -Online for multiple functions
  • Ensure the URLs resolve correctly when the documentation site is published

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions