📖 [Docs]: README pages now use the standard module landing-page format#238
Conversation
There was a problem hiding this comment.
Pull request overview
Standardizes the repository README.md into a lightweight landing page focused on installation and directing users to generated documentation / PowerShell help, instead of duplicating detailed command usage.
Changes:
- Replaces detailed usage examples with links to published documentation and
Get-Helpguidance. - Updates installation section to use
Install-PSResourcefrom the PowerShell Gallery. - Simplifies contributing guidance to a short “issues and PRs welcome” statement.
💡 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 |
1d5c93e
into
main
The GoogleFonts README is now a concise landing page. Users get a short overview, prerequisites, install commands, real usage examples for the module's actual commands, and pointers to the published documentation — without scrolling through duplicated command reference content.
What changed
## Usageshowcase using the real commandsGet-GoogleFont(list/filter fonts) andInstall-GoogleFont(-Name,-Scope AllUsers,-All).## Prerequisitesnote (FontsandAdminmodule requirements).Install-PSResource.## Documentationpoints to psmodule.io/GoogleFonts with a realGet-Help Install-GoogleFont -Examplesdiscovery snippet.google/fontson GitHub, Google Fonts site) under## Related links.## Contributingsection per the new module-README standard.Technical details
README.mdonly.