docs: refresh USB Creator setup screenshots - #523
Conversation
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
unraid-docs | 172d507 | Commit Preview URL Branch Preview URL |
Aug 07 2026, 12:06 AM |
|
Important Review skippedReview was skipped due to path filters ⛔ Files ignored due to path filters (5)
CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including ⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
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. Comment |
e289d93 to
172d507
Compare
## Summary This adds a complete, screenshot-led guide for creating a new Unraid bootable USB with the USB Creator. ## Why This Exists The page previously provided only a high-level six-step outline. Users needed the actual Creator flow, 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, 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. - 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 #523. ## Behavior Changes Documentation-only. Users now see a complete path from USB Creator download through first boot, with troubleshooting for missing drives, boot failures, and GUID licensing problems. ## 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. - 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. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Renamed and refreshed the Unraid bootable media setup guide. - Added detailed instructions for using USB Creator, including language and release selection, drive validation, server configuration, image writing, and boot setup. - Added troubleshooting guidance and warnings about data erasure, licensing identifiers, boot scripts, and drive visibility. - Preserved the existing manual installation instructions. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
## 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 #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.
Automated refresh from the passing USB Creator journey 2be4b16783f157b0780a84052f8fbfcd34ab78d2-31111748734. Every image was accepted only after the full virtual USB write and filesystem verification passed, and the docs importer revalidated each SHA-256 digest.