Skip to content

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

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#63
Marius Storhaug (MariusStorhaug) wants to merge 3 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 Fonts README now follows the standard PSModule landing-page format, so users get a clear, task-focused entry point.

What changed

  • Restored a runnable Usage showcase with real commands: list (Get-Font), install (Install-Font), and uninstall (Uninstall-Font) fonts, including user vs. AllUsers scope.
  • Restored the Supported platforms note (Linux, macOS, Windows) and the pointer to the NerdFonts/GoogleFonts modules.
  • Fixed the discovery snippet to use a real command: Get-Help -Name Install-Font -Examples.
  • Kept Installation on Install-PSResource and removed the Contributing section (handled by the separate community-files rollout).

Only README.md is touched.

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

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

Standardizes the repository README.md into a lightweight landing page for the Fonts PowerShell module, shifting detailed usage guidance to PowerShell help and the published documentation site.

Changes:

  • Simplified the README introduction and removed in-README command walkthroughs.
  • Added a documentation section pointing to the published module docs.
  • Updated contribution guidance to a concise “issues/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:36
@MariusStorhaugMarius Storhaug (MariusStorhaug) added the documentation Improvements or additions to documentation label Jul 12, 2026

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 6 comments.

Comment threadREADME.md Outdated
Comment threadREADME.md Outdated
Comment threadREADME.md Outdated
Comment threadREADME.md Outdated
Comment threadREADME.md Outdated
Comment threadREADME.md Outdated
@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 review requested due to automatic review settings July 12, 2026 09:40

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

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

Labels

documentationImprovements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@MariusStorhaug