Skip to content

feat(help): add online command help - #9

Merged
constantinhager merged 1 commit into
mainfrom
feature/add-online-help
Aug 21, 2026
Merged

constantinhager merged 1 commit into
mainfrom
feature/add-online-help

Conversation

@constantinhager

Copy link
Copy Markdown
Owner

This pull request introduces automatic generation of external help files and adds online-help URLs to every exported command in the module. The changes ensure that each command's help documentation is linked to its stable GitHub source, and that MAML-formatted help is consistently generated and packaged as part of the build and CI workflows. This improves both the developer and user experience by making up-to-date, version-controlled help easily accessible and ensuring documentation quality.

Help system improvements:

  • Added a .LINK entry with the stable GitHub source URL to the comment-based help of every exported command in the source/Public directory, so Get-Help <command> -Online opens the version-controlled help source. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13]

  • Updated documentation and system patterns to specify that every exported function must begin its .LINK list with its GitHub source URL, and clarified the use of PlatyPS for generating external help. [1] [2]

Build and CI workflow enhancements:

  • Integrated PlatyPS into the required modules and build pipeline, enabling automatic generation and packaging of MAML-formatted help files during both normal builds and CI pack workflows. [1] [2] [3]

Documentation and changelog updates:

  • Updated CHANGELOG.md and project memory bank files to reflect the addition of command-level online-help URLs and automated help generation as a recent milestone. [1] [2] [3]

Co-authored-by: AI Assistant <ai@example.com>
@constantinhager
constantinhager merged commit c7cd782 into main Aug 21, 2026
5 checks passed
@constantinhager
constantinhager deleted the feature/add-online-help branch August 21, 2026 09:24
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