Skip to content

Define standard URL convention for PowerShell function .LINK docs #35

Description

Problem

We need a documented, cross-org standard for the .LINK section in PowerShell comment-based help so Get-Help can reliably point users to published command documentation.

Today, MSXOrg/docs requires .LINK in help structure, but does not define a canonical URL shape for published function docs. That makes links inconsistent between repositories and harder to generate automatically.

Proposed standard

Document a canonical function-doc URL pattern, for example:

  • https://psmodule.io/<ModuleName>/Functions/<FunctionName>/
  • If function files are grouped by domain folder:
    • https://psmodule.io/<ModuleName>/Functions/<Group>/<FunctionName>/

Example:

  • https://psmodule.io/Jwt/Functions/Token/New-Jwt/

Why this matters

  • Consistent Get-Help navigation for all modules
  • Easier automatic generation of .LINK blocks
  • Less ambiguity for maintainers and tooling

Suggested docs updates

  1. MSXOrg/docs: add URL-convention guidance under Coding-Standards/PowerShell/Functions.md (or Documentation.md).
  2. PSModule/docs: add module-specific mapping guidance under Modules/Standards.md (or Process-PSModule docs) so framework tooling can generate links predictably.
  3. Optionally define fallback behavior when grouped folders are not used.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions