-
-
Notifications
You must be signed in to change notification settings - Fork 15
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Migrate Documentation to Markdown and External Help #1
Comments
I'd still recommend minimal comment based help. SYNOPSIS and LINK would probably be best. That way if I do Get-Help Get-Branch -Online I'd be sent to the online help page. |
disagree. An user should be able to get basic help (including samples) from The online help will indeed show the latest version of the documentation of the function. but it will not be versioned. An argument can be made, that generating an online .cab file with the help, which the user can get for local usage with ConfluencePS has already done this. all documentation is in the |
Oh good! I actually prefer full comment based help, but I thought the issue was to move AWAY from that to markdown. I assume the cbh will be pulled out at CI/CD? |
No. this moves away from CBH. and uses External Help instead... basically, the help engine parses the comments for the CBH. this is very flawed; and used as a simple way to get help for cmdlets...
pros and cons are here: AtlassianPS/AtlassianPS#1 |
Lol, I don't think that's the right link ;) |
fixed |
Description
In order to have a documentation that is easier to access, easier to edit and maintain, and more flexible, we shall use PlatyPS for the help of the function.
Discussion on this topic: AtlassianPS/AtlassianPS#1
Task
.md
files in/docs
.md
files (.EXAMPLE
block can have more that 1 command in it)about_<module>
The text was updated successfully, but these errors were encountered: