Skip to content

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

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

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

Conversation

@MariusStorhaug

@MariusStorhaug Marius Storhaug (MariusStorhaug) commented Jul 6, 2026

Copy link
Copy Markdown
Member

README pages now act as concise landing pages. Implemented modules point users to installation, psmodule.io, and PowerShell help instead of duplicating command reference content. Placeholder and in-progress modules now state their status clearly so users are not shown scaffold examples as working usage.

⚠️ This PR has no linked issue. Consider creating one for traceability.

Changed: README pages defer to generated documentation

Implemented module READMEs now provide a short overview, installation commands, and links to generated documentation. Command usage remains in PowerShell help and generated docs.

Get-Command -Module <ModuleName>
Get-Help -Name 'CommandName' -Examples

Changed: Placeholder modules identify their status

Repositories that still contain scaffold or stub module code now say they are placeholders or in progress instead of showing template commands as if they worked.

Technical Details

  • Updates README.md only.
  • Aligns repository READMEs with the default introduced in PSModule/Template-PSModule.
  • Keeps command-level details out of README pages to avoid duplicating generated module documentation.

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

Copilot AI 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 README.md into a lightweight landing page (per Template-PSModule default) by removing detailed command usage and directing users to PowerShell help and hosted docs instead.

Changes:

  • Replaces the long-form README introduction/features/usage sections with a brief module description.
  • Moves usage guidance to external documentation and Get-Help/Get-Command discovery.
  • Simplifies the contributing section to point users to the issue tracker.

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

@github-actions

github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown

Super-linter summary

Language Validation result
CHECKOV Pass ✅
GITHUB_ACTIONS Pass ✅
GITLEAKS Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
MARKDOWN Pass ✅
NATURAL_LANGUAGE Fail ❌
POWERSHELL Pass ✅
PRE_COMMIT Pass ✅
SPELL_CODESPELL Pass ✅
TRIVY Pass ✅
YAML Pass ✅

Super-linter detected linting errors

For more information, see the GitHub Actions workflow run

Powered by Super-linter

NATURAL_LANGUAGE

/github/workspace/README.md
  3:35  ✓ error  Incorrect term: “Base64”, use “base64” instead  terminology

✖ 1 problem (1 error, 0 warnings, 0 infos)
✓ 1 fixable problem.
Try to run: $ textlint --fix [file]

@MariusStorhaug Marius Storhaug (MariusStorhaug) changed the title Docs: standardize README 📖 [Docs]: README pages now use the standard module landing-page format Jul 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants