Skip to content

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

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

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

Conversation

@MariusStorhaug

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

Copy link
Copy Markdown
Member

The CasingStyle README is now a concise landing page that follows the standard PSModule format, so users get a clear path from install to real usage without wading through duplicated command reference.

What changed

  • Restored a ## Usage showcase with three realistic examples using the module's exported commands: convert a string between casing styles (ConvertTo-CasingStyle), detect a string's casing style (Get-CasingStyle), and split a string by casing style (Split-CasingStyle).
  • Kept ## Installation on Install-PSResource and a ## Documentation section that points to psmodule.io/CasingStyle plus Get-Command / Get-Help discovery using a real command.
  • Removed the ## Contributing section (community/contribution flow lives outside the published landing page).

Notes

  • Updates README.md only.
  • Section order matches the standard: title → overview → Installation → Usage → 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

This PR standardizes README.md into a lightweight module landing page (aligned with the Template-PSModule default), shifting detailed usage guidance to PowerShell help and published docs.

Changes:

  • Replaced the long-form README content with a brief module description and streamlined sections.
  • Kept installation instructions minimal and added a single documentation link.
  • Simplified contributing guidance to point users to the issue tracker.

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

Comment thread README.md Outdated
@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 Pass ✅
POWERSHELL Pass ✅
PRE_COMMIT Pass ✅
SPELL_CODESPELL Pass ✅
TRIVY Pass ✅
YAML Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

@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 Pass ✅
POWERSHELL Pass ✅
PRE_COMMIT Pass ✅
SPELL_CODESPELL Pass ✅
TRIVY Pass ✅
YAML Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

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

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@MariusStorhaug Marius Storhaug (MariusStorhaug) changed the title Docs: standardize README 📖 [Docs]: README pages now use the standard module landing-page format Jul 6, 2026
Copilot AI review requested due to automatic review settings July 12, 2026 09:18
@MariusStorhaug Marius Storhaug (MariusStorhaug) added the documentation Improvements or additions to documentation label Jul 12, 2026

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

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (1)

README.md:12

  • Install-PSResource is not available by default in many PowerShell environments (notably Windows PowerShell 5.1), so copy/pasting this block can fail with “The term 'Install-PSResource' is not recognized…”. Consider either switching to Install-Module or documenting a PowerShellGet fallback / PSResourceGet prerequisite so installation instructions work for a broader set of users.
Install-PSResource -Name CasingStyle
Import-Module -Name CasingStyle

@github-actions

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 Pass ✅
POWERSHELL Pass ✅
PRE_COMMIT Pass ✅
SPELL_CODESPELL Pass ✅
TRIVY Pass ✅
YAML Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

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

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants