Skip to content

📖 [Docs]: Rework the Uri README into the standard module landing page - #17

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

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

Conversation

@MariusStorhaug

@MariusStorhaugMarius Storhaug (MariusStorhaug) commented Jul 6, 2026

Copy link
Copy Markdown
Member

Reworks the Uri module README into the standard landing-page format so users get a real, copy-pasteable overview instead of an empty template.

What changed:

  • Restored a ## Usage showcase with real examples: parse a query string with ConvertFrom-UriQueryString, build one with ConvertTo-UriQueryString, and assemble complete URIs with New-Uri (plus Get-Uri/Test-Uri), each with expected output.
  • Fixed the Documentation discovery snippet from the placeholder Get-Help <CommandName> to a real command (Get-Help -Name New-Uri -Examples).
  • Removed the boilerplate ## Contributing section (governance files are handled by a separate rollout).
  • Kept the module title # Uri and the Install-PSResource installation block.

CopilotAI review requested due to automatic review settings July 6, 2026 06:30

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Standardizes README.md into a lightweight landing page for the Uri PowerShell module, shifting detailed usage guidance to PowerShell help and published documentation.

Changes:

  • Simplified the README introduction and removed extended inline usage examples.
  • Kept installation instructions focused on PowerShell Gallery installation/import.
  • Pointed users to published docs and PowerShell help/command discovery for detailed usage.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

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
@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