Add canonical public help links

MariusStorhaug · Copilot · MariusStorhaug · commit def7ed59aee2 · 2026-07-25T23:14:12.000+02:00
Co-authored-by: Copilot App &lt;223556219+Copilot@users.noreply.github.com&gt;
diff --git a/src/functions/public/Auth/Connect-DomeneshopAccount.ps1 b/src/functions/public/Auth/Connect-DomeneshopAccount.ps1
@@ -33,6 +33,9 @@ function Connect-DomeneshopAccount {
         .NOTES
         Credentials are encrypted by the Context module.
 
+        .LINK
+        https://psmodule.io/Domeneshop/Functions/Connect-DomeneshopAccount/
+
         .LINK
         https://api.domeneshop.no/docs/
     #>
diff --git a/src/functions/public/Auth/Get-DomeneshopContext.ps1 b/src/functions/public/Auth/Get-DomeneshopContext.ps1
@@ -31,6 +31,9 @@ function Get-DomeneshopContext {
         .NOTES
         The configuration entry used to track the default is excluded from list output.
 
+        .LINK
+        https://psmodule.io/Domeneshop/Functions/Get-DomeneshopContext/
+
         .LINK
         https://psmodule.io/Context/
     #>
diff --git a/src/functions/public/Ddns/Update-DomeneshopDdns.ps1 b/src/functions/public/Ddns/Update-DomeneshopDdns.ps1
@@ -24,6 +24,9 @@ function Update-DomeneshopDdns {
         .NOTES
         Uses the caller's public IP address when MyIP is omitted.
 
+        .LINK
+        https://psmodule.io/Domeneshop/Functions/Update-DomeneshopDdns/
+
         .LINK
         https://api.domeneshop.no/docs/
     #>
diff --git a/src/functions/public/Dns/Add-DomeneshopDnsRecord.ps1 b/src/functions/public/Dns/Add-DomeneshopDnsRecord.ps1
@@ -24,6 +24,9 @@ function Add-DomeneshopDnsRecord {
         .NOTES
         Uses the default context when Context is omitted.
 
+        .LINK
+        https://psmodule.io/Domeneshop/Functions/Add-DomeneshopDnsRecord/
+
         .LINK
         https://api.domeneshop.no/docs/
     #>
diff --git a/src/functions/public/Dns/Get-DomeneshopDnsRecord.ps1 b/src/functions/public/Dns/Get-DomeneshopDnsRecord.ps1
@@ -29,6 +29,9 @@ function Get-DomeneshopDnsRecord {
         .NOTES
         Uses the default context when Context is omitted.
 
+        .LINK
+        https://psmodule.io/Domeneshop/Functions/Get-DomeneshopDnsRecord/
+
         .LINK
         https://api.domeneshop.no/docs/
     #>
diff --git a/src/functions/public/Dns/Remove-DomeneshopDnsRecord.ps1 b/src/functions/public/Dns/Remove-DomeneshopDnsRecord.ps1
@@ -24,6 +24,9 @@ function Remove-DomeneshopDnsRecord {
         .NOTES
         Uses the default context when Context is omitted.
 
+        .LINK
+        https://psmodule.io/Domeneshop/Functions/Remove-DomeneshopDnsRecord/
+
         .LINK
         https://api.domeneshop.no/docs/
     #>
diff --git a/src/functions/public/Dns/Set-DomeneshopDnsRecord.ps1 b/src/functions/public/Dns/Set-DomeneshopDnsRecord.ps1
@@ -24,6 +24,9 @@ function Set-DomeneshopDnsRecord {
         .NOTES
         Uses the default context when Context is omitted.
 
+        .LINK
+        https://psmodule.io/Domeneshop/Functions/Set-DomeneshopDnsRecord/
+
         .LINK
         https://api.domeneshop.no/docs/
     #>
diff --git a/src/functions/public/Domains/Get-DomeneshopDomain.ps1 b/src/functions/public/Domains/Get-DomeneshopDomain.ps1
@@ -27,6 +27,9 @@ function Get-DomeneshopDomain {
         .NOTES
         Uses the default context when Context is omitted.
 
+        .LINK
+        https://psmodule.io/Domeneshop/Functions/Get-DomeneshopDomain/
+
         .LINK
         https://api.domeneshop.no/docs/
     #>
diff --git a/src/functions/public/Forwards/Add-DomeneshopForward.ps1 b/src/functions/public/Forwards/Add-DomeneshopForward.ps1
@@ -28,6 +28,9 @@ function Add-DomeneshopForward {
         .NOTES
         Uses the default context when Context is omitted.
 
+        .LINK
+        https://psmodule.io/Domeneshop/Functions/Add-DomeneshopForward/
+
         .LINK
         https://api.domeneshop.no/docs/
     #>
diff --git a/src/functions/public/Forwards/Get-DomeneshopForward.ps1 b/src/functions/public/Forwards/Get-DomeneshopForward.ps1
@@ -29,6 +29,9 @@ function Get-DomeneshopForward {
         .NOTES
         Uses the default context when Context is omitted.
 
+        .LINK
+        https://psmodule.io/Domeneshop/Functions/Get-DomeneshopForward/
+
         .LINK
         https://api.domeneshop.no/docs/
     #>
diff --git a/src/functions/public/Forwards/Remove-DomeneshopForward.ps1 b/src/functions/public/Forwards/Remove-DomeneshopForward.ps1
@@ -24,6 +24,9 @@ function Remove-DomeneshopForward {
         .NOTES
         Uses the default context when Context is omitted.
 
+        .LINK
+        https://psmodule.io/Domeneshop/Functions/Remove-DomeneshopForward/
+
         .LINK
         https://api.domeneshop.no/docs/
     #>
diff --git a/src/functions/public/Forwards/Set-DomeneshopForward.ps1 b/src/functions/public/Forwards/Set-DomeneshopForward.ps1
@@ -28,6 +28,9 @@ function Set-DomeneshopForward {
         .NOTES
         Uses the default context when Context is omitted.
 
+        .LINK
+        https://psmodule.io/Domeneshop/Functions/Set-DomeneshopForward/
+
         .LINK
         https://api.domeneshop.no/docs/
     #>
diff --git a/src/functions/public/Get-PSModuleTest.ps1 b/src/functions/public/Get-PSModuleTest.ps1
@@ -24,6 +24,9 @@
         .NOTES
         This command is retained as the module's baseline smoke-test command.
 
+        .LINK
+        https://psmodule.io/Domeneshop/Functions/Get-PSModuleTest/
+
         .LINK
         https://github.com/PSModule/Domeneshop
     #>
diff --git a/src/functions/public/Invoices/Get-DomeneshopInvoice.ps1 b/src/functions/public/Invoices/Get-DomeneshopInvoice.ps1
@@ -29,6 +29,9 @@ function Get-DomeneshopInvoice {
         .NOTES
         Uses the default context when Context is omitted.
 
+        .LINK
+        https://psmodule.io/Domeneshop/Functions/Get-DomeneshopInvoice/
+
         .LINK
         https://api.domeneshop.no/docs/
     #>
diff --git a/tests/PublicHelpLinks.Tests.ps1 b/tests/PublicHelpLinks.Tests.ps1
@@ -0,0 +1,33 @@
+#Requires -Modules @{ ModuleName = 'Pester'; ModuleVersion = '6.0.0'; MaximumVersion = '6.*' }
+
+[Diagnostics.CodeAnalysis.SuppressMessageAttribute(
+    'PSUseDeclaredVarsMoreThanAssignments', '',
+    Justification = 'Required for Pester test discovery.'
+)]
+[CmdletBinding()]
+param()
+
+$sourcePath = Join-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -ChildPath 'src'
+$publicFunctionsPath = Join-Path -Path $sourcePath -ChildPath 'functions'
+$publicFunctionsPath = Join-Path -Path $publicFunctionsPath -ChildPath 'public'
+$testCases = Get-ChildItem -Path $publicFunctionsPath -Filter '*.ps1' -Recurse -File |
+    Sort-Object -Property FullName |
+    ForEach-Object {
+        @{
+            FunctionName = $_.BaseName
+            Path         = $_.FullName
+        }
+    }
+
+Describe 'Public function help links' {
+    It 'puts the canonical documentation link first for <FunctionName>' -ForEach $testCases {
+        param($FunctionName, $Path)
+
+        $content = Get-Content -Path $Path -Raw
+        $links = [regex]::Matches($content, '(?ms)^\s*\.LINK\s*\r?\n\s*(?<Uri>\S+)')
+
+        $links.Count | Should -BeGreaterThan 0
+        $links[0].Groups['Uri'].Value |
+            Should -Be "https://psmodule.io/Domeneshop/Functions/$FunctionName/"
+    }
+}
