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

Generate CRC CLI and subcommand Help Pages for windows powershell #4610

Open
3 tasks
rohanKanojia opened this issue Feb 11, 2025 · 0 comments
Open
3 tasks

Comments

@rohanKanojia
Copy link
Contributor

Description

In #4181, we added support to generate man pages for Linux and macOS. We would like to extend this support to Windows PowerShell by providing Windows help pages.

Got it. Looks like we use a go module that creates a markdow which is converted to roff formar

platyps is a project that turns markdown into powershell help:

https://mikefrobbins.com/2023/11/30/generating-powershell-module-documentation-with-platyps/

maybe an option to consider

Originally posted by @albfan in #4608

  • Implement Windows help pages for the CRC CLI commands.
  • Ensure that the help pages are comprehensive and consistent with the existing man pages for Linux and macOS.
  • Integrate the Windows help pages with PowerShell's Get-Help command.

Acceptance Criteria

  • Windows help pages are available for all CRC CLI commands.
  • The help pages are consistent with the man pages provided for Linux and macOS.
  • Users can access the help pages using the Get-Help command in PowerShell.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant