Skip to content

docs(usb-creator): update boot media guidance - #525

Merged
Eli Bosley (elibosley) merged 1 commit into
mainfrom
docs/update-boot-media-guidance
Aug 7, 2026
Merged

docs(usb-creator): update boot media guidance#525
Eli Bosley (elibosley) merged 1 commit into
mainfrom
docs/update-boot-media-guidance

Conversation

@elibosley

Copy link
Copy Markdown
Member

Summary

This follow-up to #524 updates the screenshot-led guide for creating a new Unraid USB boot device with the USB Creator.

Why This Exists

The page previously provided only a high-level six-step outline and included stale USB-only guidance. Users needed current boot-device choices, a clear warning about erasing the selected drive, and guidance for first boot and older BIOS-only systems.

Resolution

Expand the existing Create an Unraid USB drive page with the five merged USB Creator screenshots, step-by-step UI actions, optional server/network customization notes, current flash-versus-internal-boot guidance for Unraid 7.3+, UEFI/legacy BIOS instructions, and troubleshooting.

Reviewer Considerations

  • Confirm the stable-release guidance and the optional development-image warning match the intended USB Creator experience.
  • Check the platform-specific legacy BIOS script names and first-boot guidance.
  • Confirm that internal boot is described as an onboarding choice after the initial USB boot.
  • Confirm that the USB Creator guidance does not impose a drive-capacity range; the remaining 32 GB reference applies only to Windows FAT32 formatting for manual installs.
  • The manual installation section remains in place; this change improves the recommended automated path rather than replacing it.
  • Screenshot references target the assets merged in origin/main by docs: refresh USB Creator setup screenshots #523.

Behavior Changes

Documentation-only. Users now see a complete path from USB Creator download through first boot, with flash boot or internal boot choices, troubleshooting for missing drives and boot failures, and GUID licensing guidance.

Implementation Summary

  • Renamed the page label/title to Create an Unraid USB drive.
  • Expanded the automated install section with five screenshot-linked workflow steps.
  • Documented optional Server name, Wi-Fi, and Network customization.
  • Removed the outdated 4–32 GB recommendation and separated the Windows FAT32 formatting limit from USB Creator capacity guidance.
  • Added the Unraid 7.3+ internal boot path and removed unrelated virtualization/IOMMU setup from the USB creation procedure.
  • Added UEFI versus BIOS-only boot guidance and troubleshooting.

Verification

  • ./node_modules/.bin/remark docs/unraid-os/getting-started/set-up-unraid/create-your-bootable-media.mdx --quiet --frail
  • ./node_modules/.bin/prettier --check docs/unraid-os/getting-started/set-up-unraid/create-your-bootable-media.mdx
  • git diff --check
  • Verified all five screenshot paths resolve against origin/main.
  • Full Docusaurus build not run because repository guidance discourages it for routine docs edits.

Risk

Low. Documentation-only change; the page links to existing screenshot assets and leaves the manual install instructions intact.

@coderabbitai

coderabbitai Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

@elibosley, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 33 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: db75a731-0910-4b10-ae1b-b39eea1ff741

📥 Commits

Reviewing files that changed from the base of the PR and between 0914240 and 2ebee1a.

📒 Files selected for processing (1)
  • docs/unraid-os/getting-started/set-up-unraid/create-your-bootable-media.mdx

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@elibosley
Eli Bosley (elibosley) merged commit f7ddcd9 into main Aug 7, 2026
3 of 4 checks passed
@elibosley
Eli Bosley (elibosley) deleted the docs/update-boot-media-guidance branch August 7, 2026 15:01
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