📖 [Docs]: README pages now use the standard module landing-page format#30
📖 [Docs]: README pages now use the standard module landing-page format#30Marius Storhaug (MariusStorhaug) wants to merge 5 commits into
Conversation
There was a problem hiding this comment.
Pull request overview
This PR standardizes README.md into a lightweight landing page for the Hashtable PowerShell module, moving detailed usage guidance toward PowerShell help and published module documentation.
Changes:
- Replaced the long-form module description and usage examples with a concise overview.
- Kept installation instructions minimal and added a dedicated “Documentation” section linking to published docs.
- Simplified the contributing section to direct users 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 |
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Comments suppressed due to low confidence (1)
README.md:13
- The installation section only documents
Install-PSResource, which requires PSResourceGet and won’t work in common Windows PowerShell 5.1 / PowerShellGet-only environments. Add a brief prerequisite note and/or include anInstall-Modulealternative so copy/paste installation works broadly.
Install the module from the PowerShell Gallery:
```powershell
Install-PSResource -Name Hashtable
Import-Module -Name Hashtable
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Comments suppressed due to low confidence (1)
README.md:13
- The installation section only shows
Install-PSResource, which will fail on systems that don't already have the PSResourceGet module (common on Windows PowerShell 5.1 / older setups). Since this README is intended to be copy/paste runnable, add either an explicit PSResourceGet prerequisite note or anInstall-Module(PowerShellGet) alternative.
Install the module from the PowerShell Gallery:
```powershell
Install-PSResource -Name Hashtable
Import-Module -Name Hashtable
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
📖 Docs: standard module landing-page README
The
HashtableREADME is now a proper landing page so users can get productive fast: a clear one-paragraphoverview, a copy-paste Installation block using
Install-PSResource, a Usage showcase with real,runnable examples, and a Documentation pointer to psmodule.io/Hashtable.
What changed
## Usagesection with realistic examples using the real exported commands:PSCustomObject(ConvertFrom-Hashtable)Merge-Hashtable)Format-Hashtable)Remove-HashtableEntry)Get-Help -Name ConvertTo-Hashtable -Examples).## Contributingsection (community/contribution guidance lives outside the publishedlanding page).
Install-PSResource/Import-Module.Only
README.mdchanged.