Skip to content

Fix #21: documentation audit corrections#22

Merged
tig merged 2 commits into
developfrom
fix/21-doc-audit
Jun 27, 2026
Merged

Fix #21: documentation audit corrections#22
tig merged 2 commits into
developfrom
fix/21-doc-audit

Conversation

@tig

@tig tig commented Jun 27, 2026

Copy link
Copy Markdown
Member

Closes #21.

Addresses every finding from the documentation audit in #21.

🔴 Correctness

  • Removed the phantom -AllProperties parameter (README.md, PLAN.md; the generated module/README.md regenerates from README.md). It doesn't exist in the cmdlet.
  • Replaced the Microsoft-boilerplate .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.
  • Replaced the Microsoft-boilerplate .github/CODE_OF_CONDUCT.md with the Contributor Covenant v2.1 (enforcement contact tig@kindel.com).
  • Fixed the dead RELATED LINKS in Show-ObjectTree.md (Out-File/Out-Printer/Out-StringOut-ConsoleGridView).
  • Rewrote Out-ConsoleGridView.md Example 8 — F7/Shift+F7 is built in now, not an external gist to download.
  • Fixed .github/workflows/README.md: ci-test runs Invoke-Build Build, Test (not … Package) on develop and main; packaging/publishing is release-only.

🟠 Staleness

🟡 Minor

  • Fixed README.md Example 6 typos (paramter/proceses, unclosed paren).
  • demo.ps1: de-duplicated the two "Example 4" labels, removed the undefined $line filter, fixed "fitlers".
  • Added platyPS docs for the three exported history functions: Show-PSTuiHistory, Enable-PSTuiHistoryKeyHandler, Disable-PSTuiHistoryKeyHandler.

Verification

Invoke-Build -Configuration Release Build, Test green locally on pwsh 7.6 / .NET 10 — New-ExternalHelp accepts the new doc pages, 78 xUnit + 20 Pester pass.

🤖 Generated with Claude Code

tig and others added 2 commits June 27, 2026 09:12
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>
The rebranding/re-release plan it tracked is complete (1.0.x shipped; issues
#1-#6 closed), so the planning doc is no longer needed. Supersedes the earlier
-AllProperties edit to this file in this PR.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@tig tig merged commit e41ed1a into develop Jun 27, 2026
3 checks passed
@tig tig deleted the fix/21-doc-audit branch June 27, 2026 18:58

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 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 👍 / 👎.

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.

Documentation audit: discrepancies, stale Microsoft docs, and a phantom parameter

1 participant