feat(help): add online command help - #9
Merged
Merged
Conversation
Co-authored-by: AI Assistant <ai@example.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.
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
.LINKentry with the stable GitHub source URL to the comment-based help of every exported command in thesource/Publicdirectory, soGet-Help <command> -Onlineopens 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
.LINKlist with its GitHub source URL, and clarified the use of PlatyPS for generating external help. [1] [2]Build and CI workflow enhancements:
packworkflows. [1] [2] [3]Documentation and changelog updates:
CHANGELOG.mdand 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]