Skip to content

Fix docs review findings for 0.5.0 - #39

Merged
christaylorcodes merged 3 commits into
masterfrom
docs/0.5.0-review
Nov 12, 2026
Merged

christaylorcodes merged 3 commits into
masterfrom
docs/0.5.0-review

Conversation

@christaylorcodes

Copy link
Copy Markdown
Owner

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

  • Bug fix
  • New feature
  • Breaking change
  • Documentation
  • Refactoring / tests

Changes Made

Generated help:

  • Get-Help and the pages in Docs/ describe the current commands. They had kept text from earlier versions:
    examples called commands that do not exist (End-CWWake, Remove-CWCAccessSession, Get-CWCSessions), and
    18 synopses were out of date.
  • Cause: Update-MarkdownHelpModule keeps the text of existing pages, so edits to the comment-based help never
    reached Docs/ or the MAML. Build/Update-Help.ps1 now writes every page from the comment-based help
    (New-MarkdownHelp -Force) with the pinned platyPS.
  • A new module test fails if the help names a command the module does not have.

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.ps1 passed parameters New-CWCUser does not have and used the MFA secret as the
    password; it now creates the user from a credential.
  • .github/ community files, AGENTS.md and README.md brought in line with the current repository.
    SECURITY.md asks for reports by email first.

Follow-ups from the review of #36:

  • Enter-CWCSession re-reports a failed access token request with the transport's CWC.* ErrorId (it was a
    plain string error).
  • The about topic says the module is tested on Windows PowerShell 5.1 and PowerShell 7 (the manifest's minimum
    is 3.0).
  • The -ErrorAction Ignore test covers Remove-CWCSessionNote.

Open decisions for the owner

  • Enable GitHub private vulnerability reporting? SECURITY.md currently says email first.
  • Update-CWCUser always clears force-password-change and cannot clear all roles. This PR documents it and
    leaves the code unchanged.
  • A failed sign-in without MFA has no CWC.* ErrorId. Documented, not changed.

Testing

  • ./Tests/test-local.ps1 passes (analyzer, manifest, Pester on PS 7 and 5.1, docs drift)
  • Tested against a live ScreenConnect server (if applicable)

490 Pester tests pass on PowerShell 7.6 and Windows PowerShell 5.1 (4 new). ./Build/Test-ReleasePackage.ps1
passes: 0.5.0, 32 functions, no aliases or import warnings on both editions.

Checklist

  • Code follows project conventions (AGENTS.md)
  • Tests cover new/changed behavior
  • PSScriptAnalyzer reports zero errors
  • CHANGELOG.md updated (if applicable)
  • Documentation updated (if applicable)
  • New public function is in source/Public/ (not applicable)

🤖 Generated with Claude Code

christaylorcodes and others added 3 commits November 12, 2026 09:58
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>
@christaylorcodes
christaylorcodes merged commit 06a24c9 into master Nov 12, 2026
6 checks passed
@christaylorcodes
christaylorcodes deleted the docs/0.5.0-review branch November 12, 2026 21:45
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