Skip to content

📖 [Docs]: README pages now use the standard module landing-page format - #20

Open
Marius Storhaug (MariusStorhaug) wants to merge 6 commits into
mainfrom
docs/fix-readme-placeholders
Open

📖 [Docs]: README pages now use the standard module landing-page format#20
Marius Storhaug (MariusStorhaug) wants to merge 6 commits into
mainfrom
docs/fix-readme-placeholders

Conversation

@MariusStorhaug

@MariusStorhaugMarius Storhaug (MariusStorhaug) commented Jul 5, 2026

Copy link
Copy Markdown
Member

The Dns README 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

  • Real ## Usage example — shows Resolve-DnsHost -Name 'example.com' (and an IPv4-only variant with -AddressFamily) instead of scaffold placeholders.
  • Fixed help snippetGet-Help <CommandName> -Examples is now Get-Help -Name Resolve-DnsHost -Examples, a real command.
  • Removed ## Contributing — the README is the published landing page; contribution info lives elsewhere.
  • Installation uses Install-PSResource and links to psmodule.io/Dns.

Technical details

  • Updates README.md only.
  • Aligns with the standard module landing-page format (# Module → overview → Installation → Usage → Documentation).

CopilotAI review requested due to automatic review settings July 5, 2026 23:33

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment threadREADME.md Outdated
@github-actions

Copy link
Copy Markdown

Super-linter summary

LanguageValidation result
CHECKOVPass ✅
GITHUB_ACTIONSPass ✅
GITLEAKSPass ✅
GIT_MERGE_CONFLICT_MARKERSPass ✅
MARKDOWNPass ✅
NATURAL_LANGUAGEFail ❌
POWERSHELLPass ✅
PRE_COMMITPass ✅
SPELL_CODESPELLPass ✅
TRIVYPass ✅
YAMLPass ✅

Super-linter detected linting errors

For more information, see the GitHub Actions workflow run

Powered by Super-linter

NATURAL_LANGUAGE

/github/workspace/README.md
3:42 ✓ error Incorrect term: “host names”, use “hostnames” instead terminology
21:32 ✓ error Incorrect term: “host name”, use “hostname” instead terminology
25:11 ✓ error Incorrect term: “host name”, use “hostname” instead terminology
31:11 ✓ error Incorrect term: “host name”, use “hostname” instead terminology
✖ 4 problems (4 errors, 0 warnings, 0 infos)
✓ 4 fixable problems.
Try to run: $ textlint --fix [file]

@MariusStorhaugMarius Storhaug (MariusStorhaug) changed the title Docs: fix README placeholdersDocs: standardize READMEJul 6, 2026
@github-actions

Copy link
Copy Markdown

Super-linter summary

LanguageValidation result
CHECKOVPass ✅
GITHUB_ACTIONSPass ✅
GITLEAKSPass ✅
GIT_MERGE_CONFLICT_MARKERSPass ✅
MARKDOWNPass ✅
NATURAL_LANGUAGEPass ✅
POWERSHELLPass ✅
PRE_COMMITPass ✅
SPELL_CODESPELLPass ✅
TRIVYPass ✅
YAMLPass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@MariusStorhaugMarius Storhaug (MariusStorhaug) changed the title Docs: standardize README📖 [Docs]: README pages now use the standard module landing-page formatJul 6, 2026
CopilotAI review requested due to automatic review settings July 12, 2026 09:19
@MariusStorhaugMarius Storhaug (MariusStorhaug) added the documentation Improvements or additions to documentation label Jul 12, 2026

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Comment threadREADME.md Outdated

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Comment threadREADME.md Outdated
CopilotAI review requested due to automatic review settings July 12, 2026 09:23

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.

Comment threadREADME.md Outdated
Comment threadREADME.md
CopilotAI review requested due to automatic review settings July 12, 2026 09:24

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@github-actions

Copy link
Copy Markdown

Super-linter summary

LanguageValidation result
CHECKOVPass ✅
GITHUB_ACTIONSPass ✅
GITLEAKSPass ✅
GIT_MERGE_CONFLICT_MARKERSPass ✅
MARKDOWNPass ✅
NATURAL_LANGUAGEFail ❌
POWERSHELLPass ✅
PRE_COMMITPass ✅
SPELL_CODESPELLPass ✅
TRIVYPass ✅
YAMLPass ✅

Super-linter detected linting errors

For more information, see the GitHub Actions workflow run

Powered by Super-linter

NATURAL_LANGUAGE

/github/workspace/README.md
22:70 ✓ error Incorrect term: “host name”, use “hostname” instead terminology
✖ 1 problem (1 error, 0 warnings, 0 infos)
✓ 1 fixable problem.
Try to run: $ textlint --fix [file]

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

CopilotAI review requested due to automatic review settings July 12, 2026 09:37

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@github-actions

Copy link
Copy Markdown

Super-linter summary

LanguageValidation result
CHECKOVPass ✅
GITHUB_ACTIONSPass ✅
GITLEAKSPass ✅
GIT_MERGE_CONFLICT_MARKERSPass ✅
MARKDOWNPass ✅
NATURAL_LANGUAGEPass ✅
POWERSHELLPass ✅
PRE_COMMITPass ✅
SPELL_CODESPELLPass ✅
TRIVYPass ✅
YAMLPass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@MariusStorhaug