Skip to content

馃摉 [Docs]: PowerShell help links support published documentation hosts - #201

Merged
Marius Storhaug (MariusStorhaug) merged 1 commit into
mainfrom
generalize-powershell-help-links
Sep 4, 2026
Merged

馃摉 [Docs]: PowerShell help links support published documentation hosts#201
Marius Storhaug (MariusStorhaug) merged 1 commit into
mainfrom
generalize-powershell-help-links

Conversation

@MariusStorhaug

Copy link
Copy Markdown
Member

PowerShell public-function help links now describe the module's published documentation host, so modules can publish canonical online references without being tied to a specific domain.

Changed: Public help links support the module's documentation host

The public-function .LINK requirement remains explicit for absolute HTTPS URLs, trailing-slash canonical paths, grouped commands, and private-helper links to the supported public function.


Technical details
  • Updated src/docs/Coding-Standards/PowerShell/Functions.md to use a published documentation host placeholder in ungrouped and grouped URL examples.
  • Preserved the first .LINK requirement, absolute HTTPS requirement, trailing slash, grouped path, and private-helper guidance.
  • Standards and framework alignment: Documentation Model, Natural Language, Markdown, and PowerShell Functions standard checked; aligned.
  • Issue convergence sweep: Generalize PowerShell public help-link guidance beyond psmodule.io聽#200 is fully satisfied; no additional open issues were identified.
Relevant issues (or links)

Co-authored-by: Marius Storhaug <marstor@hotmail.com>
@MariusStorhaug Marius Storhaug (MariusStorhaug) added the release:skip Validate the change without publishing a release. label Sep 4, 2026
@MariusStorhaug
Marius Storhaug (MariusStorhaug) marked this pull request as ready for review September 4, 2026 17:33
@MariusStorhaug
Marius Storhaug (MariusStorhaug) merged commit 21ddfce into main Sep 4, 2026
21 checks passed
@MariusStorhaug
Marius Storhaug (MariusStorhaug) deleted the generalize-powershell-help-links branch September 4, 2026 17:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

release:skip Validate the change without publishing a release.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Generalize PowerShell public help-link guidance beyond psmodule.io

1 participant