Skip to content

[codex] Document internal boot flash label requirement#500

Merged
elibosley merged 1 commit into
mainfrom
codex/document-internal-boot-license-label
Jun 4, 2026
Merged

[codex] Document internal boot flash label requirement#500
elibosley merged 1 commit into
mainfrom
codex/document-internal-boot-license-label

Conversation

@elibosley
Copy link
Copy Markdown
Member

@elibosley elibosley commented Jun 4, 2026

Summary

  • Document that internal boot systems using a separate flash licensing USB must keep the licensing USB discoverable by FAT volume label.
  • Add the supported custom-label path using a matching unraidlabel= kernel parameter.
  • Link the Licensing FAQ directly to the internal boot flash licensing guidance.

Context

Linear: OS-309

Validation

  • pnpm exec remark docs/unraid-os/getting-started/set-up-unraid/internal-boot-faq.mdx docs/unraid-os/troubleshooting/licensing-faq.mdx --quiet --frail --no-ignore
  • pnpm exec prettier --check docs/unraid-os/getting-started/set-up-unraid/internal-boot-faq.mdx docs/unraid-os/troubleshooting/licensing-faq.mdx
  • git diff --check -- docs/unraid-os/getting-started/set-up-unraid/internal-boot-faq.mdx docs/unraid-os/troubleshooting/licensing-faq.mdx

Did not run the full build per repo guidance for routine docs edits.

Summary by CodeRabbit

  • Documentation
    • Added internal boot setup walkthrough videos
    • Enhanced guidance on USB label requirements for flash licensing scenarios
    • Improved cross-references between setup and licensing documentation sections

- Purpose: Document the current flash licensing USB label requirement for internal boot setups.

- Before: The Internal Boot FAQ said flash licensing was supported but did not explain that the separate licensing USB must be discovered by FAT label.

- Problem: Users with a valid licensing USB could miss the required label or matching kernel parameter and see flash registration failures.

- Change: Add guidance to use the default UNRAID label or a matching unraidlabel= kernel parameter, including custom label limits.

- How it works: Expand the Internal Boot FAQ flash licensing entry and link Licensing FAQ readers directly to that section.
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 4, 2026

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: b91a293d-accb-4b7b-9ed5-ea46901629e3

📥 Commits

Reviewing files that changed from the base of the PR and between a7ec950 and 5029778.

📒 Files selected for processing (2)
  • docs/unraid-os/getting-started/set-up-unraid/internal-boot-faq.mdx
  • docs/unraid-os/troubleshooting/licensing-faq.mdx

Disabled knowledge base sources:

  • Linear integration is disabled

You can enable these sources in your CodeRabbit configuration.


📝 Walkthrough

Walkthrough

Documentation updates to the internal-boot and licensing FAQ pages clarify flash licensing USB label requirements and restructure the internal-boot video presentation with improved MDX formatting.

Changes

Internal Boot and Licensing Documentation

Layer / File(s) Summary
Flash licensing USB label requirements documentation
docs/unraid-os/getting-started/set-up-unraid/internal-boot-faq.mdx, docs/unraid-os/troubleshooting/licensing-faq.mdx
The internal-boot FAQ adds FAT volume label requirements for licensing USBs, documenting the default UNRAID label, unraidlabel= kernel parameter override, and custom label constraints (11-character max, character set restrictions). Licensing FAQ link updated to reference this new guidance.
Internal Boot FAQ video and formatting updates
docs/unraid-os/getting-started/set-up-unraid/internal-boot-faq.mdx
Video walkthrough section restructured with two links as bullet items and "New server setup" video rendered within a ResponsiveEmbed component. Blank line added before FAQ answer section for improved readability.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 The docs now shine with clarity bright,
Flash labels labeled just right!
Videos in bullets, embeds so clean,
The finest FAQ yet seen!
bounces 🐇

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/document-internal-boot-license-label

Comment @coderabbitai help to get the list of available commands and usage tips.

@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
unraid-docs 5029778 Commit Preview URL

Branch Preview URL
Jun 04 2026, 09:21 PM

@elibosley elibosley marked this pull request as ready for review June 4, 2026 21:22
@elibosley elibosley merged commit 529d191 into main Jun 4, 2026
4 of 5 checks passed
@elibosley elibosley deleted the codex/document-internal-boot-license-label branch June 4, 2026 21:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant