Skip to content

📖 [Docs]: Rework the GUID README into the standard module landing page - #16

Open
Marius Storhaug (MariusStorhaug) wants to merge 4 commits into
mainfrom
docs/standardize-readme
Open

📖 [Docs]: Rework the GUID README into the standard module landing page#16
Marius Storhaug (MariusStorhaug) wants to merge 4 commits into
mainfrom
docs/standardize-readme

Conversation

@MariusStorhaug

@MariusStorhaugMarius Storhaug (MariusStorhaug) commented Jul 6, 2026

Copy link
Copy Markdown
Member

📖 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

  • A ## Usage showcase with real, copy-pasteable examples:
    • test whether a string is a GUID with Test-Guid (direct and via pipeline)
    • extract a GUID embedded in text with Search-Guid
  • ## Installation using Install-PSResource.
  • ## Documentation pointing at psmodule.io/GUID plus a real Get-Help -Name Test-Guid -Examples discovery snippet.

Cleanup

  • Restored the working usage examples that the previous standardization pass had deleted.
  • Removed the boilerplate ## Contributing section (governance files are handled by a separate rollout).

CopilotAI review requested due to automatic review settings July 6, 2026 06:30
@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

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-Help for 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.

Comment threadREADME.md Outdated
Comment threadREADME.md Outdated
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 2 comments.

Comment threadREADME.md Outdated
Comment threadREADME.md Outdated
CopilotAI review requested due to automatic review settings July 6, 2026 08:42

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

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.

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

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

@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:37
@MariusStorhaugMarius Storhaug (MariusStorhaug) changed the title 📖 [Docs]: README pages now use the standard module landing-page format📖 [Docs]: Rework the GUID README into the standard module landing pageJul 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 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

documentationDocumentation changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@MariusStorhaug