Skip to content

feat: use pnpm #423

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
elibosley merged 3 commits into from
Mar 21, 2026
Merged

feat: use pnpm #423

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
590280f
feat: use pnpm
elibosley Mar 20, 2026
f1f95e3
Refine docs typography and stabilize pnpm CI setup
elibosley Mar 20, 2026
fc1817d
Refine docs typography for readability and brand balance
elibosley Mar 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions .github/workflows/pr-lint.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,20 @@ jobs:
- name: Checkout
uses: actions/checkout@v6

- name: Setup pnpm
uses: pnpm/action-setup@v4
with:
run_install: false

- name: Setup Node.js
uses: actions/setup-node@v6
with:
node-version-file: '.nvmrc'
cache: npm
cache: pnpm
cache-dependency-path: pnpm-lock.yaml

- name: Install dependencies
run: npm ci
run: pnpm install --frozen-lockfile --prefer-offline

- name: Run lint
run: npm run lint
run: pnpm lint
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,6 @@ tmp/docusaurus-lint
.env.production.local

npm-debug.log*
pnpm-debug.log*
yarn-debug.log*
yarn-error.log*
27 changes: 14 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,8 +100,8 @@ Follow these steps to work on the docs locally.

### Prerequisites

* Node.js 18 or newer (see the `package.json` `engines` field)
* npm (ships with Node.js)
* Node.js 22 or newer (see the `package.json` `engines` field)
* pnpm via [Corepack](https://nodejs.org/api/corepack.html)
* Recommended: [nvm](https://github.com/nvm-sh/nvm) for managing Node versions

Install or update Node with nvm:
Expand All @@ -123,7 +123,8 @@ nvm use
2. Install dependencies

```bash
npm install
corepack enable
pnpm install
```

<p align="right">(<a href="#readme-top">back to top</a>)</p>
Expand All @@ -134,31 +135,31 @@ nvm use
Spin up a local Docusaurus dev server:

```bash
npm run start
pnpm start
```

The local docs dev server listens on `http://localhost:3001` by default. This keeps local iframe/embed testing aligned with [`iframe-test.html`](iframe-test.html) and other localhost examples in the repo.

Preview specific locales (one at a time):

```bash
npm run start -- --locale zh
npm run start -- --locale es
pnpm start -- --locale zh
pnpm start -- --locale es
```

Run Docusaurus lint/build checks:

```bash
npm run lint
pnpm lint
```

Additional project scripts:

* Type check TypeScript: `npm run typecheck`
* Unit tests (watch): `npm run test`
* Single test run (CI): `npm run test:run`
* Build production site: `npm run build`
* Preview production build: `npm run serve`
* Type check TypeScript: `pnpm typecheck`
* Unit tests (watch): `pnpm test`
* Single test run (CI): `pnpm test:run`
* Build production site: `pnpm build`
* Preview production build: `pnpm serve`

<p align="right">(<a href="#readme-top">back to top</a>)</p>

Expand All @@ -171,7 +172,7 @@ Once you're comfortable with the guidelines, typical workflow looks like:

1. Fork the project
2. Create a feature branch (`git checkout -b docs/your-change`)
3. Run `npm run lint` before committing
3. Run `pnpm lint` before committing
4. Commit with a clear message (`git commit -m "docs: describe change"`)
5. Push to your fork and open a pull request against `main`

Expand Down
32 changes: 10 additions & 22 deletions docs/unraid-os/getting-started/set-up-unraid/internal-boot-faq.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_label: Internal Boot FAQ
toc_max_heading_level: 3
---

import ResponsiveEmbed from "@site/src/components/ResponsiveEmbed";

# Internal Boot FAQ

This page contains frequently asked questions about internal boot in Unraid OS. For general licensing questions, see the [Licensing FAQ](../../troubleshooting/licensing-faq.mdx). For TPM-based licensing questions, see the [TPM Licensing FAQ](../../troubleshooting/tpm-licensing-faq.mdx).
Expand All @@ -19,32 +21,18 @@ If you'd rather watch a step-by-step walkthrough, these videos cover both common

<div style={{ marginBottom: "1.5rem" }}>
<p><strong>New server setup</strong></p>
<div style={{ position: "relative", paddingBottom: "56.25%", height: 0, overflow: "hidden", borderRadius: "12px" }}>
<iframe
src="https://www.youtube.com/embed/NMHaMaa8iV0"
title="Unraid 7.3 Beta: Set Up a New Server with Internal Boot"
style={{ position: "absolute", top: 0, left: 0, width: "100%", height: "100%", border: 0 }}
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
referrerPolicy="strict-origin-when-cross-origin"
credentialless=""
allowFullScreen
/>
</div>
<ResponsiveEmbed
src="https://www.youtube.com/embed/NMHaMaa8iV0"
title="Unraid 7.3 Beta: Set Up a New Server with Internal Boot"
/>
</div>

<div>
<p><strong>Existing server conversion</strong></p>
<div style={{ position: "relative", paddingBottom: "56.25%", height: 0, overflow: "hidden", borderRadius: "12px" }}>
<iframe
src="https://www.youtube.com/embed/sruWM1PqjVo"
title="Unraid 7.3 Beta: Convert Your Server to Internal Boot"
style={{ position: "absolute", top: 0, left: 0, width: "100%", height: "100%", border: 0 }}
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
referrerPolicy="strict-origin-when-cross-origin"
credentialless=""
allowFullScreen
/>
</div>
<ResponsiveEmbed
src="https://www.youtube.com/embed/sruWM1PqjVo"
title="Unraid 7.3 Beta: Convert Your Server to Internal Boot"
/>
</div>

### I switched from flash boot to internal boot, but the system still boots from flash. What should I do? {#internal-boot-bios-order}
Expand Down
20 changes: 7 additions & 13 deletions ...usaurus-plugin-content-docs/current/unraid-os/troubleshooting/licensing-faq.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_label: Lizenz-FAQ
toc_max_heading_level: 3
---

import ResponsiveEmbed from "@site/src/components/ResponsiveEmbed";

# Lizenz-FAQ

Diese Seite enthält häufig gestellte Fragen zur Lizenzierung des Unraid OS. Für allgemeine Fehlerbehebungsfragen siehe das [Haupt-FAQ](faq.mdx).
Expand Down Expand Up @@ -48,19 +50,11 @@ Aktivierungscodes sind einmalig zur Generierung Ihrer Unraid-Lizenzschlüssel-Da

:::note[Instructional Video]

<div style={{ display: "flex", justifyContent: "center", margin: "20px 0" }}>
<iframe
title="Loom Durchlauf: Unraid-Lizenzierung FAQ"
width="560"
height="315"
src="https://www.loom.com/embed/3ceb40440240474aaa80a0b7e3e69cb2"
frameBorder="0"
webkitAllowFullScreen
mozAllowFullScreen
allowFullScreen
allow="Autoplay; Vollbild"
/>
</div>
<ResponsiveEmbed
src="https://www.loom.com/embed/3ceb40440240474aaa80a0b7e3e69cb2"
title="Loom Durchlauf: Unraid-Lizenzierung FAQ"
allow="autoplay; fullscreen"
/>

:::

Expand Down
10 changes: 7 additions & 3 deletions ...usaurus-plugin-content-docs/current/unraid-os/troubleshooting/licensing-faq.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_label: Preguntas Frecuentes sobre Licencias
toc_max_heading_level: 3
---

import ResponsiveEmbed from "@site/src/components/ResponsiveEmbed";

# Preguntas Frecuentes sobre Licencias

Esta página contiene preguntas frecuentes sobre la concesión de licencias de Unraid OS. Para preguntas generales sobre solucion de problemas, consulte las [preguntas frecuentes principales](faq.mdx).
Expand Down Expand Up @@ -46,9 +48,11 @@ Los códigos de activación son de un solo uso para generar su archivo de clave

:::note[Instructional Vídeo]

<div style={{ display: "flex", justifyContent: "center", margin: "20px 0" }}>
<iframe title="Recorrido por Loom: Preguntas frecuentes sobre la licencia de Unraid" width="560" height="315" src="https://www.loom.com/embed/3ceb40440240474aaa80a0b7e3e69cb2" frameBorder="0" webkitAllowFullScreen mozAllowFullScreen allowFullScreen allow="autoplay; pantalla completa" />
</div>
<ResponsiveEmbed
src="https://www.loom.com/embed/3ceb40440240474aaa80a0b7e3e69cb2"
title="Recorrido por Loom: Preguntas frecuentes sobre la licencia de Unraid"
allow="autoplay; fullscreen"
/>

:::

Expand Down
10 changes: 7 additions & 3 deletions ...usaurus-plugin-content-docs/current/unraid-os/troubleshooting/licensing-faq.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_label: FAQ de la licence
toc_max_heading_level: 3
---

import ResponsiveEmbed from "@site/src/components/ResponsiveEmbed";

# FAQ de la licence

Cette page contient des questions fréquemment posées sur la licence du système Unraid OS. Pour les questions générales de dépannage, consultez la [FAQ principale](faq.mdx).
Expand Down Expand Up @@ -46,9 +48,11 @@ Les codes d'activation sont à usage unique pour générer votre fichier de clé

:::note[Instructional Vidéo]

<div style={{ display: "flex", justifyContent: "center", margin: "20px 0" }}>
<iframe title="Loom présentation : FAQ sur les licences Unraid" width="560" height="315" src="https://www.loom.com/embed/3ceb40440240474aaa80a0b7e3e69cb2" frameBorder="0" webkitAllowFullScreen mozAllowFullScreen allowFullScreen allow="lecture automatique; plein écran" />
</div>
<ResponsiveEmbed
src="https://www.loom.com/embed/3ceb40440240474aaa80a0b7e3e69cb2"
title="Loom présentation : FAQ sur les licences Unraid"
allow="autoplay; fullscreen"
/>

:::

Expand Down
10 changes: 7 additions & 3 deletions ...usaurus-plugin-content-docs/current/unraid-os/troubleshooting/licensing-faq.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_label: 许可证常见问题解答
toc_max_heading_level: 3
---

import ResponsiveEmbed from "@site/src/components/ResponsiveEmbed";

# 许可证常见问题解答

此页面包含有关 Unraid 操作系统许可的常见问题。对于一般故障排除问题，请参阅[主要常见问题解答](faq.mdx)。
Expand Down Expand Up @@ -46,9 +48,11 @@ toc_max_heading_level: 3

:::note[Instructional 视频]

<div style={{ display: "flex", justifyContent: "center", margin: "20px 0" }}>
<iframe title="Loom walkthrough: Unraid licensing FAQ" width="560" height="315" src="https://www.loom.com/embed/3ceb40440240474aaa80a0b7e3e69cb2" frameBorder="0" webkitAllowFullScreen mozAllowFullScreen allowFullScreen allow="自动播放；全屏" />
</div>
<ResponsiveEmbed
src="https://www.loom.com/embed/3ceb40440240474aaa80a0b7e3e69cb2"
title="Loom walkthrough: Unraid licensing FAQ"
Copy link
Contributor

@coderabbitai coderabbitai bot Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Localize the iframe title text for the zh page.

The current title is English, which is inconsistent with the page locale and screen-reader language flow.

Suggested change 
-  title="Loom walkthrough: Unraid licensing FAQ"
+  title="Loom 演示：Unraid 许可证常见问题解答"
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
title="Loom walkthrough: Unraid licensing FAQ"
title="Loom 演示：Unraid 许可证常见问题解答"
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In
`@i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/troubleshooting/licensing-faq.mdx`
at line 53, The iframe's title attribute on this Chinese (zh) MDX page is
currently English; update the iframe's title value in licensing-faq.mdx to a
Chinese/localized string (e.g., translate "Loom walkthrough" to Chinese) so
screen readers receive locale-consistent text — locate the iframe element in
this file and replace the title attribute with the localized Chinese text and
verify it matches the page locale and aria/screen-reader expectations.

allow="autoplay; fullscreen"
/>

:::

Expand Down
Loading