Skip to content

build: 馃Ч Use PowerForge native cmdlet documentation - #75

Merged
PrzemyslawKlys merged 2 commits into
masterfrom
codex/powerforge-native-docs
Aug 3, 2026
Merged

build: 馃Ч Use PowerForge native cmdlet documentation#75
PrzemyslawKlys merged 2 commits into
masterfrom
codex/powerforge-native-docs

Conversation

@PrzemyslawKlys

@PrzemyslawKlys PrzemyslawKlys commented Aug 2, 2026

Copy link
Copy Markdown
Member

Summary

  • Removes the MatejKafka.XmlDoc2CmdletDoc dependency and its build targets.
  • Uses the public PSPublishModule 3.0.88 / PowerForge documentation owner.
  • Regenerates Markdown and MAML and keeps binary external help discoverable with the assembly-named alias.

Validation

  • Full public-package module build completed.
  • Markdown and MAML command identities match; MAML parses as XML.
  • Regeneration is idempotent.
  • Generated help was exercised through PowerShell 7 and Windows PowerShell 5.1.
  • Repository-native .NET builds pass for the supported target frameworks.

Scope

This PR is intentionally limited to dependency removal and functional build/package/import/Get-Help preservation. Documentation-content debt such as prose, examples, defaults, output annotations, and display enrichment is recorded separately and is not hand-edited in generated artifacts here.

@chatgpt-codex-connector

Copy link
Copy Markdown

馃挕 Codex Review

https://github.com/EvotecIT/Transferetto/blob/1bb1700634143ae2c50042b4ce34876fa0aee8a9/en-US/Transferetto-help.xml#L2948
P2 Badge Restore the source-authored connection examples

When a user follows the newly shipped Get-Help Connect-FTP -Examples output, this invocation supplies neither Server nor FtpProfile; CmdletConnectFtp.ProcessRecord consequently constructs an FTP client with a null server and attempts to connect, producing a connection error. The C# XML documentation already contains three usable examples with a server/profile and credentials, so the PowerForge generation should preserve those examples instead of replacing them with this nonfunctional placeholder.


https://github.com/EvotecIT/Transferetto/blob/1bb1700634143ae2c50042b4ce34876fa0aee8a9/en-US/Transferetto-help.xml#L79
P2 Badge Publish the shell-buffer command's actual output type

When users inspect Get-Help Clear-SSHShellBuffer, the empty return metadata says the cmdlet has no output even though its own description promises buffered text and ProcessRecord calls WriteObject(string) whenever -Suppress is absent. The same omission affects most newly generated command pages because only a small subset of cmdlets declare OutputType; generate the help from declared/actual output types so pipeline consumers are not told that returned data is absent.


https://github.com/EvotecIT/Transferetto/blob/1bb1700634143ae2c50042b4ce34876fa0aee8a9/en-US/Transferetto-help.xml#L4910
P2 Badge Document the actual SSH host-key policy default

When callers omit -HostKeyPolicy, CmdletConnectSsh initializes it to TrustOnFirstUse, but the generated help reports None. This is security-relevant connection behavior rather than an unset value, so users consulting Get-Help Connect-SSH cannot determine that an unknown host key will follow the TOFU path; preserve initialized parameter defaults when generating the Markdown and MAML help.


New-ConfigurationDocumentation -Enable -PathReadme 'Docs\Readme.md' -Path 'Docs' -SyncExternalHelpToProjectRoot

P1 Badge Retain the binary cmdlet help filename

When the module is imported, Transferetto.psm1 loads the commands from Transferetto.PowerShell.dll, so PowerShell associates those cmdlets with the binary help file Transferetto.PowerShell.dll-Help.xml; this configuration instead publishes en-US/Transferetto-help.xml for the outer script-module name and removes the target that produced the binary filename. As a result, Get-Help for these cmdlets cannot discover the committed MAML and falls back to autogenerated syntax-only help; keep or generate the DLL-named help file in the module's help search path.

鈩癸笍 About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 馃憤.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, add credits to your account and enable them for code reviews in your settings.

@PrzemyslawKlys
PrzemyslawKlys merged commit dbfa6e5 into master Aug 3, 2026
8 checks passed
@PrzemyslawKlys
PrzemyslawKlys deleted the codex/powerforge-native-docs branch August 3, 2026 08:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant