📖 [Docs]: README pages now use the standard module landing-page format#11
📖 [Docs]: README pages now use the standard module landing-page format#11Marius Storhaug (MariusStorhaug) wants to merge 4 commits into
Conversation
There was a problem hiding this comment.
Pull request overview
Replaces the generated README template content with brief, repository-specific documentation that clearly communicates the project’s current placeholder/scaffold status.
Changes:
- Updates the README title and description to reflect the “Gemini” PowerShell module intent.
- Removes template boilerplate sections (installation/usage/examples/docs) and replaces them with an explicit placeholder status.
- Simplifies contributing guidance to match the current maturity of the repository.
💡 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.