Fix #21: documentation audit corrections#22
Conversation
Addresses all findings from the documentation audit (#21). Correctness: - Remove the phantom `-AllProperties` parameter (README, PLAN; the generated module/README regenerates from README). - Replace Microsoft-boilerplate .github/SECURITY.md (routed reports to MSRC) with a tui-cs policy using GitHub private vulnerability reporting. - Replace Microsoft-boilerplate .github/CODE_OF_CONDUCT.md with the Contributor Covenant v2.1 (contact tig@kindel.com). - Fix dead RELATED LINKS in Show-ObjectTree.md (Out-File/Printer/String -> Out-ConsoleGridView). - Rewrite Out-ConsoleGridView.md Example 8: F7/Shift+F7 is built in now, not a gist to download. - Fix .github/workflows/README.md: ci-test runs `Build, Test` (not Package) on develop and main; Package/publish is release-only. Staleness: - Update the workflows README "Status" section (pipeline is live; #5/#6 closed). - Drop the inaccurate "sorting" capability claim for Show-ObjectTree. - Show-ObjectTree.md: fix the dangling "Notes section" cross-reference, refresh ms.date, and correct -MinUi -> -MinUI casing. Minor: - Fix README Example 6 typos (paramter/proceses, unclosed paren). - demo.ps1: de-duplicate the "Example 4" labels, drop the undefined `$line` filter, fix "fitlers" typo. - Add platyPS docs for the three exported history functions (Show-PSTuiHistory, Enable-/Disable-PSTuiHistoryKeyHandler). Verified: Invoke-Build Build, Test green on pwsh 7.6 / .NET 10 (New-ExternalHelp accepts the new docs; 78 xUnit + 20 Pester pass). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 4db5a4e04e
ℹ️ 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".
| @@ -0,0 +1,89 @@ | |||
| --- | |||
| external help file: PSTui.dll-Help.xml | |||
There was a problem hiding this comment.
Put history function help in the module help file
These new history commands are PowerShell script functions exported from the PSTui module, but this front matter sends their platyPS content into PSTui.dll-Help.xml, which PowerShell's help naming rules reserve for C# cmdlets; exported function help is found via <ModuleName>-Help.xml unless the function has an .EXTERNALHELP directive. Because the same value is used on all three new history-function pages, Get-Help Show-PSTuiHistory -Full will fall back to the sparse comment-based help instead of showing these new examples/notes after New-ExternalHelp runs. See the PowerShell help-file naming rules: https://learn.microsoft.com/en-us/powershell/scripting/developer/help/naming-help-files?view=powershell-7.6
Useful? React with 👍 / 👎.
Closes #21.
Addresses every finding from the documentation audit in #21.
🔴 Correctness
-AllPropertiesparameter (README.md,PLAN.md; the generatedmodule/README.mdregenerates fromREADME.md). It doesn't exist in the cmdlet..github/SECURITY.md(which routed vuln reports to MSRC /secure@microsoft.com) with a tui-cs policy using GitHub private vulnerability reporting +tig@kindel.com..github/CODE_OF_CONDUCT.mdwith the Contributor Covenant v2.1 (enforcement contacttig@kindel.com).Show-ObjectTree.md(Out-File/Out-Printer/Out-String→Out-ConsoleGridView).Out-ConsoleGridView.mdExample 8 — F7/Shift+F7 is built in now, not an external gist to download..github/workflows/README.md: ci-test runsInvoke-Build Build, Test(not… Package) on develop and main; packaging/publishing is release-only.🟠 Staleness
Show-ObjectTree(the tree view has no sort).Show-ObjectTree.md: fixed the dangling "see the Notes section" cross-reference, refreshedms.date, corrected-MinUi→-MinUI.🟡 Minor
README.mdExample 6 typos (paramter/proceses, unclosed paren).demo.ps1: de-duplicated the two "Example 4" labels, removed the undefined$linefilter, fixed "fitlers".Show-PSTuiHistory,Enable-PSTuiHistoryKeyHandler,Disable-PSTuiHistoryKeyHandler.Verification
Invoke-Build -Configuration Release Build, Testgreen locally on pwsh 7.6 / .NET 10 —New-ExternalHelpaccepts the new doc pages, 78 xUnit + 20 Pester pass.🤖 Generated with Claude Code