Repository navigation
Fix docs review findings for 0.5.0 - #39
Merged
Merged
Conversation
Regenerate the help from the comment help (New-MarkdownHelp -Force), correct stale examples and synopses, and update the community files. Co-Authored-By: Claude <noreply@anthropic.com>
Enter-CWCSession re-reports a failed access token request with the transport's CWC.* ErrorId. The about topic says which editions are tested, and the -ErrorAction Ignore test covers Remove-CWCSessionNote. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
Restore help text the regenerated pages had lost (.OUTPUTS, example remarks, UTC and API-secret notes) in the comment help, and correct the note-event and New-CWCUser examples. Update-Help.ps1 documents only the source module, deletes only stale platyPS command pages, and leaves a source module the caller had loaded. Enter-CWCSession keeps the category and exception with the ErrorId. Co-Authored-By: Claude Fable 5.2 <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
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.
Pull Request
Description
Fixes what a review of the 0.5.0 documentation found, plus three follow-ups from the review of #36. Merging
this publishes nothing; no tag is pushed.
Related Issue
None.
Type of Change
Changes Made
Generated help:
Get-Helpand the pages inDocs/describe the current commands. They had kept text from earlier versions:examples called commands that do not exist (
End-CWWake,Remove-CWCAccessSession,Get-CWCSessions), and18 synopses were out of date.
Update-MarkdownHelpModulekeeps the text of existing pages, so edits to the comment-based help neverreached
Docs/or the MAML.Build/Update-Help.ps1now writes every page from the comment-based help(
New-MarkdownHelp -Force) with the pinned platyPS.Comment-based help in
source/Public/(14 files): corrected synopses, examples and parameter text. A#comment directly after a help block had become a related link in two commands.
Other documentation:
Examples/CreateNewUser.ps1passed parametersNew-CWCUserdoes not have and used the MFA secret as thepassword; it now creates the user from a credential.
.github/community files,AGENTS.mdandREADME.mdbrought in line with the current repository.SECURITY.mdasks for reports by email first.Follow-ups from the review of #36:
Enter-CWCSessionre-reports a failed access token request with the transport'sCWC.*ErrorId (it was aplain string error).
is 3.0).
-ErrorAction Ignoretest coversRemove-CWCSessionNote.Open decisions for the owner
SECURITY.mdcurrently says email first.Update-CWCUseralways clears force-password-change and cannot clear all roles. This PR documents it andleaves the code unchanged.
CWC.*ErrorId. Documented, not changed.Testing
./Tests/test-local.ps1passes (analyzer, manifest, Pester on PS 7 and 5.1, docs drift)490 Pester tests pass on PowerShell 7.6 and Windows PowerShell 5.1 (4 new).
./Build/Test-ReleasePackage.ps1passes: 0.5.0, 32 functions, no aliases or import warnings on both editions.
Checklist
source/Public/(not applicable)🤖 Generated with Claude Code