📖 [Docs]: README pages now use the standard module landing-page format#20
📖 [Docs]: README pages now use the standard module landing-page format#20Marius Storhaug (MariusStorhaug) wants to merge 6 commits into
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the repository README to replace PSModule template placeholders with module-specific documentation for the Dns PowerShell module.
Changes:
- Replaces templated name/description with a concrete module overview.
- Adds installation, command summary, and usage examples for
Resolve-DnsHost. - Updates documentation and contribution guidance to be repo-specific.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Super-linter summary
Super-linter detected linting errors For more information, see the GitHub Actions workflow run Powered by Super-linter NATURAL_LANGUAGE |
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
Super-linter detected linting errors For more information, see the GitHub Actions workflow run Powered by Super-linter NATURAL_LANGUAGE |
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
The
DnsREADME is now a concise landing page in the standard PSModule format, so users can install the module and get a real, working example at a glance.What changed
## Usageexample — showsResolve-DnsHost -Name 'example.com'(and an IPv4-only variant with-AddressFamily) instead of scaffold placeholders.Get-Help <CommandName> -Examplesis nowGet-Help -Name Resolve-DnsHost -Examples, a real command.## Contributing— the README is the published landing page; contribution info lives elsewhere.Install-PSResourceand links to psmodule.io/Dns.Technical details
README.mdonly.# Module→ overview → Installation → Usage → Documentation).