Skip to content
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

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

Open
fasteiner opened this issue Jun 21, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@fasteiner
Copy link

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

@fasteiner fasteiner added the enhancement New feature or request label Jun 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant