📖 [Docs]: README links to generated command reference - #85
Closed
Marius Storhaug (MariusStorhaug) wants to merge 4 commits into
Closed
📖 [Docs]: README links to generated command reference#85Marius Storhaug (MariusStorhaug) wants to merge 4 commits into
Marius Storhaug (MariusStorhaug) wants to merge 4 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
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)
added a commit
that referenced
this pull request
Aug 8, 2026
….1.19 (#91) NerdFonts now runs its CI and documentation builds through Process-PSModule v6.1.19, with dependency compatibility and documentation links aligned so contributors get reliable build, test, and site-generation results. ## Changed: CI and documentation builds The repository now uses the latest Process-PSModule release and builds the documentation site with Zensical. The site build remains enabled, and no contributor action is required beyond the existing workflow and documentation conventions. ## Fixed: build and test compatibility Dependency bounds, canonical documentation links, temporary download paths, and cache-fallback coverage now match the current pipeline expectations. The workflow passes only the API key it needs instead of inheriting all repository secrets. --- <details> <summary>Technical details</summary> - Updated `.github/workflows/Process-PSModule.yml` to Process-PSModule v6.1.19 and explicit `APIKey` wiring. - Updated `actions/checkout` to v7.0.1 in `Update-FontsData.yml`. - Replaced `.github/mkdocs.yml` with `.github/zensical.toml`; the site build is enabled in `.github/PSModule.yml`. - Updated `Fonts` and `Admin` dependency minimums and maximum bounds in `Install-NerdFont.ps1`. - Switched font downloads to the system temporary directory. - Replaced mocked cache-fallback behavior with a live locked-file scenario. - Added trailing slashes to canonical documentation links and added the missing contribution/documentation guidance. - Standards and framework alignment: | Changed surface | Standards checked | Framework docs checked | Result | | --- | --- | --- | --- | | `.github/workflows/**` | GitHub Actions, secret handling | Process-PSModule workflow contract | Aligned | | `.github/zensical.toml` | Documentation configuration | Process-PSModule site pipeline | Aligned | | `src/**`, `tests/**` | PowerShell dependencies, testing | Process-PSModule source/test checks | Aligned | | `README.md`, `CONTRIBUTING.md` | Documentation | Repository contribution guidance | Aligned | - Issue convergence sweep: reviewed related open work and incorporated the system temporary-directory and README documentation changes in this delivery. </details> <details> <summary>Relevant issues (or links)</summary> - PSModule/Process-PSModule#444 — wildcard `MaximumVersion` parsing was tracked upstream; current Process-PSModule releases include the upstream fix. - #69 — system temporary directory for font downloads. - #85 — README documentation link. </details> --------- Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Marius Storhaug (MariusStorhaug)
marked this pull request as draft
August 8, 2026 17:11
Marius Storhaug (MariusStorhaug)
changed the title
Contributor
No Significant Changes DetectedThis PR does not contain changes to files that would trigger a new release:
Build, test, and publish stages will be skipped for this PR. If you believe this is incorrect, please verify that your changes are in the correct locations. |
Contributor
No Significant Changes DetectedThis PR does not contain changes to files that would trigger a new release:
Build, test, and publish stages will be skipped for this PR. If you believe this is incorrect, please verify that your changes are in the correct locations. |
4 tasks
Member
Author
|
Closing as obsolete: current main already contains the complete README documentation landing-page update, leaving this PR with no remaining diff. |
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.
The NerdFonts landing page now directs users to the complete published command reference and shows how to discover module commands and example help in PowerShell.
New: Command reference guidance
The README links to the generated documentation at psmodule.io/NerdFonts and includes
Get-Command -Module NerdFontsplusGet-Help -Name Install-NerdFont -Examplesfor in-shell discovery. Existing installation, usage, caching, update, and uninstall guidance remains available on the landing page.Technical details
README.mdgains a concise Documentation section; per-command reference remains generated from comment-based help.mainwith merge commit48551adso the branch includes the current Zensical documentation build and repository guidance.README.mdRelevant issues (or links)