fix(#187): clean up public help surface (#192)

* fix(#187): clean up public help surface

 Remove Invoke-NovaCli from user-facing PlatyPS help, drop
 legacy Invoke-NovaRelease PublishOption guidance, and update
 help tests to match the intended public documentation surface.

* #187 fix: Removed Documentation section from CHANGELOG.md

Author: stiwicourage

CHANGELOG.md

@@ -45,6 +45,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
     - Adds focused CodeScene skills for refactoring with Code Health and for safeguarding AI-touched code before commit
       or
       PR readiness, instead of overloading the broader `codescene-quality` skill.
+- Added a root-level `RELEASE_NOTE.md` that is separate from `CHANGELOG.md`.
+    - `CHANGELOG.md` remains the exhaustive release history.
+    - `RELEASE_NOTE.md` now captures only public cmdlet, CLI, configuration, and migration-impacting changes, including
+      backfilled summaries for the existing released versions in `CHANGELOG.md`.
+    - `Tests.yml` now validates both files, and `Publish.yml` now finalizes both files during stable release
+      preparation.
+    - The public release-notes page now renders `RELEASE_NOTE.md` instead of the full changelog feed.
 
 ### Changed
 
@@ -75,16 +82,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   explicitly, while the published `NovaModuleTools` manifest continues to declare that dependency for installed
   workflows.
 
-### Documentation
-
-- Added a root-level `RELEASE_NOTE.md` that is separate from `CHANGELOG.md`.
-    - `CHANGELOG.md` remains the exhaustive release history.
-    - `RELEASE_NOTE.md` now captures only public cmdlet, CLI, configuration, and migration-impacting changes, including
-      backfilled summaries for the existing released versions in `CHANGELOG.md`.
-    - `Tests.yml` now validates both files, and `Publish.yml` now finalizes both files during stable release
-      preparation.
-    - The public release-notes page now renders `RELEASE_NOTE.md` instead of the full changelog feed.
-
 ### Security
 
 ## [2.3.1] - 2026-05-08

docs/NovaModuleTools/en-US/Deploy-NovaPackage.md

@@ -375,5 +375,4 @@ If no upload target can be resolved, `Deploy-NovaPackage` fails fast with a clea
 ## RELATED LINKS
 
 - https://github.com/stiwicourage/NovaModuleTools/blob/main/docs/NovaModuleTools/en-US/New-NovaModulePackage.md
-- https://github.com/stiwicourage/NovaModuleTools/blob/main/docs/NovaModuleTools/en-US/Invoke-NovaCli.md
 - https://github.com/stiwicourage/NovaModuleTools/blob/main/docs/NovaModuleTools/en-US/Publish-NovaModule.md

docs/NovaModuleTools/en-US/Initialize-NovaModule.md

@@ -162,4 +162,3 @@ metadata such as project name, description, version, author, and PowerShell host
 
 - https://github.com/stiwicourage/NovaModuleTools/blob/main/docs/NovaModuleTools/en-US/Invoke-NovaBuild.md
 - https://github.com/stiwicourage/NovaModuleTools/blob/main/docs/NovaModuleTools/en-US/Get-NovaProjectInfo.md
-- https://github.com/stiwicourage/NovaModuleTools/blob/main/docs/NovaModuleTools/en-US/Invoke-NovaCli.md

docs/NovaModuleTools/en-US/Install-NovaCli.md

@@ -33,8 +33,7 @@ By default, the launcher is installed to `~/.local/bin/nova` on macOS and Linux.
 
 After a successful install, `Install-NovaCli` also prints the release notes link from the installed module manifest.
 
-Use this command when you want `nova` to be available as a launcher-oriented CLI entrypoint instead of invoking
-`Invoke-NovaCli` directly from PowerShell.
+Use this command when you want `nova` to be available directly from your shell as the launcher-oriented CLI entrypoint.
 
 ## EXAMPLES
 
@@ -176,5 +175,4 @@ After running `Install-NovaCli`, add the destination directory to your shell `PA
 
 ## RELATED LINKS
 
-- `Invoke-NovaCli`
 - `Publish-NovaModule`

docs/NovaModuleTools/en-US/Invoke-NovaCli.md

@@ -29,12 +29,6 @@ PS> Invoke-NovaRelease [-Local] [[-ModuleDirectoryPath] <string>] [[-ApiKey] <st
 PS> Invoke-NovaRelease -Repository <string> [[-ModuleDirectoryPath] <string>] [[-ApiKey] <string>] [-SkipTests] [-ContinuousIntegration] [-OverrideWarning] [[-Path] <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
-### PublishOption
-
-```text
-PS> Invoke-NovaRelease -PublishOption <hashtable> [-SkipTests] [-ContinuousIntegration] [-OverrideWarning] [[-Path] <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
-```
-
 ## DESCRIPTION
 
 `Invoke-NovaRelease` orchestrates a full release flow:
@@ -220,37 +214,6 @@ AcceptedValues: [ ]
 HelpMessage: ''
 ```
 
-### -PublishOption
-
-DEPRECATED: This function will be removed in a future version.
-Legacy hashtable form for publish behavior.
-
-Common keys:
-
-- `Local`
-- `Repository`
-- `ApiKey`
-- `ModuleDirectoryPath`
-
-Prefer the direct `-Local`, `-Repository`, `-ModuleDirectoryPath`, and `-ApiKey` parameters for new automation.
-
-```yaml
-Type: System.Collections.Hashtable
-DefaultValue: '@{}'
-SupportsWildcards: false
-Aliases: [ ]
-ParameterSets:
-  - Name: PublishOption
-    Position: Named
-    IsRequired: false
-    ValueFromPipeline: false
-    ValueFromPipelineByPropertyName: false
-    ValueFromRemainingArguments: false
-DontShow: false
-AcceptedValues: [ ]
-HelpMessage: ''
-```
-
 ### -Path
 
 Project root path where the release command should run.
@@ -334,12 +297,6 @@ ParameterSets:
     Position: Named
   - Name: Repository
     Position: Named
-  - Name: PublishOption
-    Position: Named
-    IsRequired: false
-    ValueFromPipeline: false
-    ValueFromPipelineByPropertyName: false
-    ValueFromRemainingArguments: false
 DontShow: false
 AcceptedValues: [ ]
 HelpMessage: ''

docs/NovaModuleTools/en-US/Invoke-NovaRelease.md

@@ -297,4 +297,3 @@ guard only for the current packaging run.
 
 - https://github.com/stiwicourage/NovaModuleTools/blob/main/docs/NovaModuleTools/en-US/Invoke-NovaBuild.md
 - https://github.com/stiwicourage/NovaModuleTools/blob/main/docs/NovaModuleTools/en-US/Test-NovaBuild.md
-- https://github.com/stiwicourage/NovaModuleTools/blob/main/docs/NovaModuleTools/en-US/Invoke-NovaCli.md

docs/NovaModuleTools/en-US/New-NovaModulePackage.md

@@ -39,10 +39,6 @@ Installs the bundled command-line launcher into a user command directory on macO
 
 Builds the current NovaModuleTools project into a ready-to-import PowerShell module.
 
-### `PS> Invoke-NovaCli`
-
-Routes Nova commands through the explicit PowerShell cmdlet entrypoint.
-
 ### `PS> Invoke-NovaRelease`
 
 Runs the Nova release pipeline (build, test, version bump, rebuild, publish).

docs/NovaModuleTools/en-US/NovaModuleTools.md

@@ -157,7 +157,6 @@ prerelease setting.
 
 ## RELATED LINKS
 
-- `Invoke-NovaCli`
 - `Get-NovaUpdateNotificationPreference`
 - `Set-NovaUpdateNotificationPreference`
 - `Invoke-NovaBuild`

docs/NovaModuleTools/en-US/Update-NovaModuleTools.md

@@ -463,6 +463,11 @@ Describe 'Nova command model - project, help, and build behavior' {
         $script:helpActivationTestCases | Should -Not -BeNullOrEmpty
     }
 
+    It 'help docs keep Invoke-NovaCli out of the user-facing help surface' {
+        $script:helpActivationTestCases.HelpTarget | Should -Not -Contain 'Invoke-NovaCli'
+        (Test-Path -LiteralPath (Join-Path $script:helpDocsDir 'en-US/Invoke-NovaCli.md')) | Should -BeFalse
+    }
+
     It 'Get-Help loads synopsis for every command help file discovered in docs' {
         foreach ($testCase in $script:helpActivationTestCases) {
             $help = Get-Help $testCase.HelpTarget -ErrorAction Stop
@@ -510,12 +515,17 @@ Describe 'Nova command model - project, help, and build behavior' {
             'WhatIf',
             'Confirm'
         )
+        $undocumentedLegacyParametersByCommand = @{
+            'Invoke-NovaRelease' = @('PublishOption')
+        }
 
         foreach ($testCase in $script:helpActivationTestCases) {
             $command = Get-Command $testCase.HelpTarget -ErrorAction Stop
+            $undocumentedLegacyParameters = @($undocumentedLegacyParametersByCommand[$testCase.HelpTarget])
             $expectedParameterNames = @(
             $command.Parameters.Keys |
                     Where-Object {$_ -notin $commonParameterNames} |
+                    Where-Object {$_ -notin $undocumentedLegacyParameters} |
                     Sort-Object
             )
 
@@ -540,6 +550,13 @@ Describe 'Nova command model - project, help, and build behavior' {
         }
     }
 
+    It 'Get-Help keeps legacy Invoke-NovaRelease -PublishOption guidance out of user-facing help' {
+        $fullText = Get-Help Invoke-NovaRelease -Full -ErrorAction Stop | Out-String
+
+        $fullText | Should -Not -Match ([regex]::Escape('-PublishOption'))
+        {Get-Help Invoke-NovaRelease -Parameter PublishOption -ErrorAction Stop} | Should -Throw
+    }
+
     It 'Get-Help explains how to manage prerelease self-update eligibility' {
         $buildHelp = Get-Help Invoke-NovaBuild -Full -ErrorAction Stop | Out-String
         $updateHelp = Get-Help Update-NovaModuleTool -Full -ErrorAction Stop | Out-String