Skip to content

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

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

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

Conversation

@MariusStorhaug

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

Copy link
Copy Markdown
Member

📖 Docs: standard module landing-page README

The Hashtable README is now a proper landing page so users can get productive fast: a clear one-paragraph
overview, a copy-paste Installation block using Install-PSResource, a Usage showcase with real,
runnable examples, and a Documentation pointer to psmodule.io/Hashtable.

What changed

  • Added a ## Usage section with realistic examples using the real exported commands:
    • Convert a hashtable to a PSCustomObject (ConvertFrom-Hashtable)
    • Merge hashtables with overrides (Merge-Hashtable)
    • Format a hashtable as PowerShell code (Format-Hashtable)
    • Remove entries by criteria (Remove-HashtableEntry)
  • Documentation discovery snippet uses a real command (Get-Help -Name ConvertTo-Hashtable -Examples).
  • Removed the ## Contributing section (community/contribution guidance lives outside the published
    landing page).
  • Installation continues to use Install-PSResource / Import-Module.

Only README.md changed.

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

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 Hashtable PowerShell module, moving detailed usage guidance toward PowerShell help and published module documentation.

Changes:

  • Replaced the long-form module description and usage examples with a concise overview.
  • Kept installation instructions minimal and added a dedicated “Documentation” section linking to published docs.
  • Simplified the contributing section to direct users to the issue tracker.

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

Comment thread README.md
@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
Contributor

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 1 comment.

Comment thread README.md
Copilot AI review requested due to automatic review settings July 6, 2026 08:42

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@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
Contributor

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 1 comment.

Comment thread README.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 1 comment.

Comment thread README.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 1 comment.

Comment thread README.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 1 comment.

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

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

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:13

  • The installation section only documents Install-PSResource, which requires PSResourceGet and won’t work in common Windows PowerShell 5.1 / PowerShellGet-only environments. Add a brief prerequisite note and/or include an Install-Module alternative so copy/paste installation works broadly.
Install the module from the PowerShell Gallery:

```powershell
Install-PSResource -Name Hashtable
Import-Module -Name Hashtable

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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:13

  • The installation section only shows Install-PSResource, which will fail on systems that don't already have the PSResourceGet module (common on Windows PowerShell 5.1 / older setups). Since this README is intended to be copy/paste runnable, add either an explicit PSResourceGet prerequisite note or an Install-Module (PowerShellGet) alternative.
Install the module from the PowerShell Gallery:

```powershell
Install-PSResource -Name Hashtable
Import-Module -Name Hashtable

@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

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