Skip to content

Make your documentation more accessible directly from PowerShell facilitating Get-Help #3

@fasteiner

Description

@fasteiner

Is your feature request related to a problem? Please describe.
I really liked your community demo on PSConfEU, so I directly downloaded your module. Unfourtunatley, the documentation is not accessible from the shell, but only over github:
image

Furthermore, there are no examples in the offline help of the functions, as shown above.

Describe the solution you'd like
Describe every parameter seperatley, specify .OUTPUTS and also please add examples in order for people to quickly understand how to use your module without needing to browse the internet.

See resources here; https://learn.microsoft.com/en-us/powershell/scripting/developer/help/writing-help-for-windows-powershell-modules?view=powershell-7.3

Furthermore, please provide an online version via github pages: https://learn.microsoft.com/en-us/powershell/scripting/developer/help/supporting-online-help?view=powershell-7.3

Additional context
It is best practice to provide help in the shell, as stated numerous times on this years PSConfEU

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions