📖 [Docs]: README pages now use the standard module landing-page format#85
Open
Marius Storhaug (MariusStorhaug) wants to merge 3 commits into
Open
📖 [Docs]: README pages now use the standard module landing-page format#85Marius Storhaug (MariusStorhaug) wants to merge 3 commits into
Marius Storhaug (MariusStorhaug) wants to merge 3 commits into
Conversation
Copilot started reviewing on behalf of
Marius Storhaug (MariusStorhaug)
July 6, 2026 06:30
View session
Contributor
There was a problem hiding this comment.
Pull request overview
Standardizes the repository’s README.md into a lightweight module landing page (aligned with Template-PSModule defaults), moving detailed command usage guidance to PowerShell help and generated documentation.
Changes:
- Replaces the long, usage-heavy README with a concise description + installation snippet.
- Adds an explicit documentation link and directs users to
Get-Command/Get-Helpfor command details. - Simplifies the contributing section to a short “issues and PRs welcome” statement.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
Marius Storhaug (MariusStorhaug)
changed the title
Applies the content-preserving README default: keeps the upstream attribution and donation note, prerequisites and the Fonts dependency, a representative usage showcase, and the caching plus update/versioning behavior, instead of deleting them.
Copilot started reviewing on behalf of
Marius Storhaug (MariusStorhaug)
July 9, 2026 04:15
View session
Comment on lines
+39
to
+40
| Install-NerdFont -Name 'FiraCode' -Scope AllUsers | ||
| Uninstall-Font -Name 'FiraCode*' |
Contributor
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
The README is the published psmodule.io landing page and the only home for prerequisites, upstream attribution/donations, usage, cache locations and inspection, update/versioning semantics, and uninstall guidance. Restores that content and adds a Documentation section pointing to the generated command reference and Get-Help.
Copilot started reviewing on behalf of
Marius Storhaug (MariusStorhaug)
July 9, 2026 04:57
View session
|
|
||
| ## Documentation | ||
|
|
||
| Every command has full reference documentation, generated from its comment-based help and published at [psmodule.io/NerdFonts](https://psmodule.io/NerdFonts/). Explore the commands and read detailed help directly from PowerShell: |
Contributor
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Keeps the full README content — the README is the published psmodule.io/NerdFonts landing page and the only home for prerequisites, the upstream attribution/donation note to Ryan L McIntyre (@ryanoasis), usage, the cache locations + inspection snippet, the update/versioning semantics, and the uninstall guidance.
Change is additive: adds a Documentation section pointing to the generated command reference and
Get-Helpwith a real cmdlet.Follows the updated README default (PSModule/docs#61). The per-command reference is generated separately from comment-based help; narrative content stays in the README because that is where it publishes.