📖 [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 4 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 |
README pages now act as concise landing pages. Implemented modules point users to installation, psmodule.io, and PowerShell help instead of duplicating command reference content. Placeholder and in-progress modules now state their status clearly so users are not shown scaffold examples as working usage.
Changed: README pages defer to generated documentation
Implemented module READMEs now provide a short overview, installation commands, and links to generated documentation. Command usage remains in PowerShell help and generated docs.
Changed: Placeholder modules identify their status
Repositories that still contain scaffold or stub module code now say they are placeholders or in progress instead of showing template commands as if they worked.
Technical Details
README.mdonly.PSModule/Template-PSModule.