📖 [Docs]: README pages now use the standard module landing-page format - #35
📖 [Docs]: README pages now use the standard module landing-page format#35Marius Storhaug (MariusStorhaug) wants to merge 5 commits into
Conversation
There was a problem hiding this comment.
Pull request overview
Standardizes the repository README into a lightweight landing page, shifting detailed command usage guidance to PowerShell help and the generated module documentation site.
Changes:
- Replaces the long usage examples with a minimal “Documentation” section pointing to psmodule.io.
- Updates the installation snippet to use
Install-PSResource. - Simplifies the “Contributing” section to a short pointer to the issue tracker.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
What changed
The
DynamicParamsREADME is now a proper module landing page that follows the standard PSModule format, so anyone landing on the repo (or on psmodule.io) immediately sees how to install the module and how to use it.User-facing impact
Install-PSResource(PSResourceGet), the modern, supported install path.New-DynamicParamandNew-DynamicParamDictionary:DynamicParamsDSL style,... | New-DynamicParam @_ | New-DynamicParamDictionary).Get-Command/Get-Help New-DynamicParam -Examples).## Contributingsection (handled separately) and the empty## Prerequisitesnote.