Skip to content

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

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

📖 [Docs]: README pages now use the standard module landing-page format#28
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

📖 [Docs]: Standard module landing-page README

The Markdown README is now a focused landing page that follows the standard PSModule format, so users get a clear
what/why, a one-command install, and a runnable showcase without wading through content that duplicates command help.

User-facing changes

  • Usage restored, using the real commands. A concise ## Usage section shows how to compose a document with
    Set-MarkdownSection, Set-MarkdownTable, Set-MarkdownCodeBlock, Set-MarkdownDetails, and Set-MarkdownParagraph.
    (The previous PR had removed the entire Usage section along with the old DSL example.)
  • Working help snippet. The discovery example is now Get-Help -Name Set-MarkdownTable -Examples instead of the
    placeholder Get-Help <CommandName> -Examples.
  • Install-PSResource for installation and a psmodule.io/Markdown documentation pointer (unchanged from standard).
  • Removed ## Contributing. Contribution guidance is not part of the published landing page.

Only README.md changed.

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

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

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

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.

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