📖 [Docs]: README pages now use the standard module landing-page format#41
📖 [Docs]: README pages now use the standard module landing-page format#41Marius Storhaug (MariusStorhaug) wants to merge 4 commits into
Conversation
There was a problem hiding this comment.
Pull request overview
Standardizes the repository’s README.md into a lightweight landing page (installation + links), pushing detailed usage guidance toward PowerShell help and generated module documentation.
Changes:
- Replaces the detailed README usage section with links to published documentation and a minimal “discover commands / get help” snippet.
- Updates installation guidance and simplifies contribution text.
💡 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 |
Admin's README is now a concise landing page that follows the standard PSModule module-README format, so users get what they need at a glance instead of duplicated command reference.
What changed
Test-Adminto detect whether the current session is elevated (administrator/root), including a guard-clause pattern for gating operations that require elevation.Install-PSResource(the modern PSResourceGet cmdlet) instead of the deprecatedInstall-Module.## Acknowledgementsplaceholder (no real attribution) and the outdated PowerShell 5.1 prerequisite note were removed.Landing-page shape
# Admin→ one-paragraph overview →## Installation→## Usage→## Documentation(links to psmodule.io/Admin plus a realGet-Command/Get-Helpdiscovery snippet).Technical details
README.mdonly.PSModule/Template-PSModule.