Conversation
* Fix #21: documentation audit corrections 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> * Delete PLAN.md 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> --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Promotes
develop→mainto ship the next patch release.Includes #22 — documentation audit corrections (#21): removed the phantom
-AllProperties, replaced the Microsoft-boilerplate SECURITY.md / CODE_OF_CONDUCT.md with tui-cs versions, fixed stale/broken cmdlet help, added platyPS docs for the history functions, and removed the now-completePLAN.md.Docs-only change. The release pipeline (
release.yml) will auto-resolve the next patch version (1.0.3 tagged → 1.0.4), build/test under PS 7.6, publish to PSGallery, tag, and create a GitHub Release.🤖 Generated with Claude Code