📖 [Docs]: Rework the GUID README into the standard module landing page#16
📖 [Docs]: Rework the GUID README into the standard module landing page#16Marius Storhaug (MariusStorhaug) wants to merge 4 commits into
Conversation
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
This PR standardizes README.md into a lightweight landing page, shifting detailed usage guidance toward generated module documentation and PowerShell help.
Changes:
- Simplifies the README introduction and removes in-README usage examples.
- Adds a documentation link and guidance to use
Get-Command/Get-Helpfor discovery. - Updates install/import instructions and contributing text to a standardized template style.
💡 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 |
📖 Docs: Rework the GUID README into the standard module landing page
The README is now a concise landing page for the module.
What you get
## Usageshowcase with real, copy-pasteable examples:Test-Guid(direct and via pipeline)Search-Guid## InstallationusingInstall-PSResource.## Documentationpointing at psmodule.io/GUID plus a realGet-Help -Name Test-Guid -Examplesdiscovery snippet.Cleanup
## Contributingsection (governance files are handled by a separate rollout).