Skip to content

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

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

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

Conversation

@MariusStorhaug

@MariusStorhaugMarius Storhaug (MariusStorhaug) commented Jul 6, 2026

Copy link
Copy Markdown
Member

What changed

The DynamicParams README is now a proper module landing page that follows the standard PSModule format, so anyone landing on the repo (or on psmodule.io) immediately sees how to install the module and how to use it.

User-facing impact

  • Installation now uses Install-PSResource (PSResourceGet), the modern, supported install path.
  • Usage is back and expanded into three runnable showcases using the real commands New-DynamicParam and New-DynamicParamDictionary:
    • splatting style (building the dictionary explicitly),
    • DynamicParams DSL style,
    • pipeline style (... | New-DynamicParam @_ | New-DynamicParamDictionary).
  • Documentation points to psmodule.io/DynamicParams with a real command-discovery snippet (Get-Command / Get-Help New-DynamicParam -Examples).
  • Links retains the unique reference to Microsoft Learn's advanced/dynamic parameters documentation.
  • Removed the boilerplate ## Contributing section (handled separately) and the empty ## Prerequisites note.

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

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

Standardizes the repository README into a lightweight landing page, shifting detailed command usage guidance to PowerShell help and the generated module documentation site.

Changes:

  • Replaces the long usage examples with a minimal “Documentation” section pointing to psmodule.io.
  • Updates the installation snippet to use Install-PSResource.
  • Simplifies the “Contributing” section to a short pointer to the issue tracker.

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

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

@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 1 comment.

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_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:20
@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

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

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

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

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