Skip to content

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

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

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

Conversation

@MariusStorhaug

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

Copy link
Copy Markdown
Member

Admin's README is now a concise landing page that follows the standard PSModule module-README format, so users get what they need at a glance instead of duplicated command reference.

What changed

  • Usage example restored — the README now shows how to use Test-Admin to detect whether the current session is elevated (administrator/root), including a guard-clause pattern for gating operations that require elevation.
  • Install-PSResource — installation now uses Install-PSResource (the modern PSResourceGet cmdlet) instead of the deprecated Install-Module.
  • Contributing section removed — community/contribution boilerplate no longer lives on the published landing page.
  • Stale content dropped — the empty ## Acknowledgements placeholder (no real attribution) and the outdated PowerShell 5.1 prerequisite note were removed.

Landing-page shape

# Admin → one-paragraph overview → ## Installation## Usage## Documentation (links to psmodule.io/Admin plus a real Get-Command/Get-Help discovery snippet).

Technical details

  • Updates README.md only.
  • Aligns with the module-README standard from PSModule/Template-PSModule.

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

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

Standardizes the repository’s README.md into a lightweight landing page (installation + links), pushing detailed usage guidance toward PowerShell help and generated module documentation.

Changes:

  • Replaces the detailed README usage section with links to published documentation and a minimal “discover commands / get help” snippet.
  • Updates installation guidance and simplifies contribution text.

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

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

@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 Documentation changes 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 1 comment.

Comment thread README.md

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
@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
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 review requested due to automatic review settings July 12, 2026 09:29

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.

@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 Documentation changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants