Repository navigation
Commit f7ddcd9
authored
docs(usb-creator): update boot media guidance (#525)
## 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.1 parent 0914240 commit f7ddcd9
1 file changed
Lines changed: 18 additions & 10 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
10 | | - | |
| 10 | + | |
11 | 11 | | |
12 | | - | |
| 12 | + | |
13 | 13 | | |
14 | 14 | | |
15 | 15 | | |
16 | | - | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
17 | 19 | | |
18 | 20 | | |
19 | 21 | | |
| |||
35 | 37 | | |
36 | 38 | | |
37 | 39 | | |
38 | | - | |
| 40 | + | |
39 | 41 | | |
40 | 42 | | |
41 | 43 | | |
| |||
121 | 123 | | |
122 | 124 | | |
123 | 125 | | |
124 | | - | |
125 | | - | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
126 | 134 | | |
127 | 135 | | |
128 | 136 | | |
| |||
144 | 152 | | |
145 | 153 | | |
146 | 154 | | |
147 | | - | |
| 155 | + | |
148 | 156 | | |
149 | 157 | | |
150 | 158 | | |
151 | | - | |
| 159 | + | |
152 | 160 | | |
153 | 161 | | |
154 | 162 | | |
155 | | - | |
| 163 | + | |
156 | 164 | | |
157 | 165 | | |
158 | 166 | | |
| |||
166 | 174 | | |
167 | 175 | | |
168 | 176 | | |
169 | | - | |
| 177 | + | |
170 | 178 | | |
171 | 179 | | |
172 | 180 | | |
| |||
0 commit comments