📖 [Docs]: README pages now use the standard module landing-page format#28
Open
Marius Storhaug (MariusStorhaug) wants to merge 2 commits into
Open
📖 [Docs]: README pages now use the standard module landing-page format#28Marius Storhaug (MariusStorhaug) wants to merge 2 commits into
Marius Storhaug (MariusStorhaug) wants to merge 2 commits into
Conversation
Copilot started reviewing on behalf of
Marius Storhaug (MariusStorhaug)
July 6, 2026 06:30
View session
There was a problem hiding this comment.
Pull request overview
This PR standardizes README.md into a lightweight landing page for the PowerShell module, shifting detailed usage guidance to PowerShell help and the generated documentation site.
Changes:
- Replaces the long, example-heavy README content with a short module summary and minimal installation instructions.
- Adds a documentation section linking to the published module docs and pointing users to
Get-Command/Get-Helpfor usage details. - Simplifies the contributing section to a brief “issues and PRs welcome” statement.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
Copilot started reviewing on behalf of
Marius Storhaug (MariusStorhaug)
July 12, 2026 09:57
View session
Copilot started reviewing on behalf of
Marius Storhaug (MariusStorhaug)
July 12, 2026 09:58
View session
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
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.
📖 [Docs]: Standard module landing-page README
The
MarkdownREADME is now a focused landing page that follows the standard PSModule format, so users get a clearwhat/why, a one-command install, and a runnable showcase without wading through content that duplicates command help.
User-facing changes
## Usagesection shows how to compose a document withSet-MarkdownSection,Set-MarkdownTable,Set-MarkdownCodeBlock,Set-MarkdownDetails, andSet-MarkdownParagraph.(The previous PR had removed the entire Usage section along with the old DSL example.)
Get-Help -Name Set-MarkdownTable -Examplesinstead of theplaceholder
Get-Help <CommandName> -Examples.psmodule.io/Markdowndocumentation pointer (unchanged from standard).## Contributing. Contribution guidance is not part of the published landing page.Only
README.mdchanged.