📖 [Docs]: README pages now use the standard module landing-page format#24
Open
Marius Storhaug (MariusStorhaug) wants to merge 6 commits into
Open
📖 [Docs]: README pages now use the standard module landing-page format#24Marius Storhaug (MariusStorhaug) wants to merge 6 commits into
Marius Storhaug (MariusStorhaug) wants to merge 6 commits into
Conversation
Copilot started reviewing on behalf of
Marius Storhaug (MariusStorhaug)
July 6, 2026 08:24
View session
There was a problem hiding this comment.
Pull request overview
This PR standardizes README.md into a lightweight landing page aligned with the Template-PSModule default, moving detailed usage guidance to PowerShell help and published module docs.
Changes:
- Simplified the README to focus on installation, documentation, and contributing.
- Removed prerequisite and usage/example sections to avoid duplicating command documentation.
- Added pointers to published documentation and PowerShell discovery/help commands.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Copilot started reviewing on behalf of
Marius Storhaug (MariusStorhaug)
July 6, 2026 09:01
View session
Comment on lines
+21
to
+22
| Get-Command -Module {{ NAME }} | ||
| Get-Help -Name CommandName -Examples |
Marius Storhaug (MariusStorhaug)
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
New PowerShell module repositories now start with a README that includes a concise capability showcase before the generated documentation link. This keeps README pages useful as a start page while leaving command reference details in PowerShell help and generated docs.
Changed: README pages introduce capability without becoming a manual
The template README now includes a
## Capabilitiessection after installation. New modules can use this section for concise examples that explain the module's value and first mental model.Changed: Detailed documentation remains generated
The README still points users to the
psmodule.io/<ModuleName>URL pattern and PowerShell help for command-level details.Technical Details
README.mdonly.{{ NAME }}and{{ DESCRIPTION }}as intentional template tokens.PSModule/docs.