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
- MSXOrg/docs: add URL-convention guidance under
Coding-Standards/PowerShell/Functions.md (or Documentation.md).
- PSModule/docs: add module-specific mapping guidance under
Modules/Standards.md (or Process-PSModule docs) so framework tooling can generate links predictably.
- Optionally define fallback behavior when grouped folders are not used.
Problem
We need a documented, cross-org standard for the
.LINKsection in PowerShell comment-based help soGet-Helpcan reliably point users to published command documentation.Today, MSXOrg/docs requires
.LINKin 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>/https://psmodule.io/<ModuleName>/Functions/<Group>/<FunctionName>/Example:
https://psmodule.io/Jwt/Functions/Token/New-Jwt/Why this matters
Get-Helpnavigation for all modules.LINKblocksSuggested docs updates
Coding-Standards/PowerShell/Functions.md(orDocumentation.md).Modules/Standards.md(or Process-PSModule docs) so framework tooling can generate links predictably.