Skip to content

Conversation

@ayushdhakar
Copy link

PlatyPS follows this schema: https://github.com/PowerShell/platyPS/blob/master/docs/developer/platyPS/platyPS.schema.md
The files in this PR were not following this schema and hence failing Get-Help xml content generation.

Fix issues during PlatyPS conversion of .md to .xml for Get-Help command to work in PowerShell module
Updated the SYNOPSIS section to include a note about feature availability.
Updated the SYNOPSIS section to include a note about the feature's release status.
Update note regarding feature release status.
Updated the SYNOPSIS section to include a note about feature availability.
Added detailed descriptions for various recording and transcription scenarios, including keys for customization.
@learn-build-service-prod
Copy link

@ayushdhakar ayushdhakar changed the title Update documentation format for platyPS to generate Get-Help xml content from .MD files Update .md documentation for 5 recently updated cmdlets so that PlatyPS is able to generate Get-Help xml content Nov 28, 2025
@ayushdhakar
Copy link
Author

@ayushdhakar please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement
@microsoft-github-policy-service agree company="Microsoft"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant