Skip to content

📖 [Docs]: Font check, update, and uninstall workflows now documented#67

Open
Marius Storhaug (MariusStorhaug) wants to merge 4 commits intomainfrom
docs/66-document-font-management-workflows
Open

📖 [Docs]: Font check, update, and uninstall workflows now documented#67
Marius Storhaug (MariusStorhaug) wants to merge 4 commits intomainfrom
docs/66-document-font-management-workflows

Conversation

@MariusStorhaug
Copy link
Copy Markdown
Member

@MariusStorhaug Marius Storhaug (MariusStorhaug) commented May 4, 2026 •
edited
Loading

The README now documents the three most common post-install workflows that were previously undiscoverable: checking whether a NerdFont is installed, updating to the latest version, and uninstalling a font. These workflows use the Fonts module that is already installed automatically as a dependency.

New: Check if a NerdFont is installed

The README now includes examples showing how to use Get-Font to query whether a specific NerdFont is installed, for both CurrentUser and AllUsers scopes.

New: Update an installed NerdFont

A new section explains that font files do not embed a NerdFonts release version, so there is no direct "outdated" check. The documented approach is to reinstall with Install-NerdFont -Name '<font>' -Force to ensure the latest version.

New: Uninstall a NerdFont

The README now shows how to use Uninstall-Font to remove NerdFonts, with examples for both user and system scopes. The section links to the Fonts module documentation and notes the dependency is installed automatically.

Technical Details

@MariusStorhaug Marius Storhaug (MariusStorhaug) changed the title Docs: Document font management workflows 📖 [Docs]: Font check, update, and uninstall workflows now documented May 4, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 4, 2026

Super-linter summary

Language Validation result
CHECKOV Pass ✅
GITHUB_ACTIONS Pass ✅
GITLEAKS Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
JSON 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) marked this pull request as ready for review May 4, 2026 14:16
@MariusStorhaug Marius Storhaug (MariusStorhaug) requested a review from a team as a code owner May 4, 2026 14:16
Copilot AI review requested due to automatic review settings May 4, 2026 14:16
Copilot AI reviewed May 4, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

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 updates the project README to document common post-installation workflows (checking whether a font is installed, updating to the latest version, and uninstalling) using the existing Fonts module dependency, addressing the discoverability gap described in issue #66.

Changes:

  • Added README usage guidance for verifying installed NerdFonts via Get-Font (current user vs all users).
  • Documented the recommended “update” approach as a reinstall using Install-NerdFont -Force due to lack of embedded version metadata in font files.
  • Added README examples for uninstalling fonts via Uninstall-Font, including user and system scopes.

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

Comment thread README.md Outdated
Closed
@MariusStorhaug
Add AllUsers scope example to Update section per review feedback
c76bf8a 
The update/reinstall section only showed the default CurrentUser scope,
inconsistent with Check and Uninstall sections that show both scopes.
Added -Scope AllUsers variant with elevation note to prevent users from
accidentally creating a separate per-user install when updating a
system-wide font.
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 4, 2026

Super-linter summary

Language Validation result
CHECKOV Pass ✅
GITHUB_ACTIONS Pass ✅
GITLEAKS Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
JSON 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 reviewed May 4, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

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.

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

Comment thread README.md Outdated
Open
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 4, 2026

Super-linter summary

Language Validation result
CHECKOV Pass ✅
GITHUB_ACTIONS Pass ✅
GITLEAKS Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
JSON 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 review requested due to automatic review settings May 4, 2026 21:02
Copilot AI reviewed May 4, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

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.

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

Comment thread README.md
```

This re-downloads and installs the font version bundled with your installed NerdFonts module, overwriting any existing
files. To pick up newer font releases, update the NerdFonts module first (`Update-Module -Name NerdFonts`).
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 4, 2026

Super-linter summary

Language Validation result
CHECKOV Pass ✅
GITHUB_ACTIONS Pass ✅
GITLEAKS Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
JSON 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 reviewed May 4, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

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.

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

Comment thread README.md
```

This re-downloads and installs the font version bundled with your installed NerdFonts module, overwriting any existing
files. To pick up newer font releases, update the NerdFonts module first (`Update-Module -Name NerdFonts`).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

At least 1 approving review is required to merge this pull request.

Assignees

@MariusStorhaug Marius Storhaug (MariusStorhaug)

Labels

Docs Norelease

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Document how to check installed fonts, detect outdated fonts, and uninstall fonts

2 participants

@MariusStorhaug