Open
Conversation
Contributor
📝 WalkthroughWalkthroughAdded an Onboarding wizard section (Unraid 7.3+), revised license registration text and images, standardized inline style quotes and punctuation, normalized headings/lists (BIOS/storage checklist), tightened troubleshooting and pre-deploy guidance, and adjusted MDX block formatting and spacing across the file. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan for PR comments
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 |
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
unraid-docs | 88fdb43 | Commit Preview URL Branch Preview URL |
Mar 12 2026, 01:50 PM |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.mdx (1)
140-159: Use semantic lists for the BIOS checklist.These checklist items are plain lines with hard breaks, which is brittle in MDX and less friendly for accessibility/translation tooling. Converting them to actual list items will render more consistently and be easier to maintain.
Suggested shape
### Basic Settings -✅ Set the USB flash drive as the primary boot device.\ - ✅ Configure the storage controller to **%%AHCI|ahci%%** mode with SATA connections.\ - ✅ Set the controller to **%%HBA mode|hba-mode%%** (not **%%RAID|raid%%**).\ - ✅ Disable **Secure Boot** as it is not supported by Unraid OS. +- ✅ Set the USB flash drive as the primary boot device. +- ✅ Configure the storage controller to **%%AHCI|ahci%%** mode with SATA connections. +- ✅ Set the controller to **%%HBA mode|hba-mode%%** (not **%%RAID|raid%%**). +- ✅ Disable **Secure Boot** because it is not supported by Unraid OS.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.mdx` around lines 140 - 159, Convert the hard‑wrapped checklist lines under the "Basic Settings", "Advanced Settings", and "Troubleshooting Tips" headings into proper semantic Markdown/MDX lists (e.g., unordered lists or task list items like - [x]) so each checkbox becomes a real list item; update the lines containing the checklist tokens (e.g., "Set the USB flash drive as the primary boot device.", "Configure the storage controller to **%%AHCI|ahci%%** mode...", "Enable **%%hardware virtualization|hvm%%**...", and the troubleshooting entries) to be list items rather than plain text with trailing backslashes, preserving the inline tokens (%%...%%) and check states.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In
`@docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.mdx`:
- Around line 107-123: The "Register your license key" section currently targets
Unraid 7.2 and earlier but doesn't cover the Unraid 7.3+ onboarding flow; either
add a new "For Unraid 7.3 and later" subsection under the same heading that
describes the new registration path (what UI entry point to use during
first-boot onboarding or the updated WebGUI flow, and screenshots to match) or
explicitly mark the existing content as "Legacy (7.2 and earlier)". Update or
add text and images referenced in the section (the "Get Started" and "Install
trial key" descriptions) to reflect the correct steps for 7.3+, and keep the
heading "Register your license key" so readers can find both legacy and
current-version guidance.
---
Nitpick comments:
In
`@docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.mdx`:
- Around line 140-159: Convert the hard‑wrapped checklist lines under the "Basic
Settings", "Advanced Settings", and "Troubleshooting Tips" headings into proper
semantic Markdown/MDX lists (e.g., unordered lists or task list items like -
[x]) so each checkbox becomes a real list item; update the lines containing the
checklist tokens (e.g., "Set the USB flash drive as the primary boot device.",
"Configure the storage controller to **%%AHCI|ahci%%** mode...", "Enable
**%%hardware virtualization|hvm%%**...", and the troubleshooting entries) to be
list items rather than plain text with trailing backslashes, preserving the
inline tokens (%%...%%) and check states.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: f03ebcf7-9904-487a-b644-397031a650d1
⛔ Files ignored due to path filters (7)
static/img/onboarding_step1.pngis excluded by!**/*.pngstatic/img/onboarding_step2.pngis excluded by!**/*.pngstatic/img/onboarding_step3a.pngis excluded by!**/*.pngstatic/img/onboarding_step3b.pngis excluded by!**/*.pngstatic/img/onboarding_step4.pngis excluded by!**/*.pngstatic/img/onboarding_step5.pngis excluded by!**/*.pngstatic/img/onboarding_step6.pngis excluded by!**/*.png
📒 Files selected for processing (1)
docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.mdx
docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.mdx
Show resolved
Hide resolved
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.mdx (1)
107-127:⚠️ Potential issue | 🟠 MajorDocument the 7.3+ registration entry point or mark this as legacy.
After the new onboarding section, this block still drops readers into the older Get Started registration flow without saying whether it applies to 7.3+. That leaves current-version users without a clear handoff from onboarding to license registration. Please either add the 7.3+ path here or explicitly label this section as a legacy 7.2-and-earlier flow.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.mdx` around lines 107 - 127, The "Register your license key" section currently points users to the older "Get Started" flow (mentions %%WebGUI|web-gui%% and "Get Started") but doesn't state whether it applies to 7.3+; update the section to either (A) add the 7.3+ registration entry point after the onboarding flow (describe where to find license registration in 7.3+ and update screenshots/labels accordingly), or (B) explicitly mark this section as "Legacy (7.2 and earlier)" and link to the new 7.3+ onboarding documentation; update the heading or callout text (the "Register your license key" heading, the "Get Started" references, and the "Tools → Registration" note) so readers have a clear handoff for current-version users.
🧹 Nitpick comments (1)
docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.mdx (1)
61-105: Colocate the new screenshots with this doc instead of/img.These newly added images are still referenced from the global
/imgbucket, which makes the page harder to maintain and drifts from the contributor checklist for new doc assets. Please move them into an adjacentassets/folder and switch the references to relative paths/imports.Example pattern
-  + Apply the same pattern to the other new onboarding and registration screenshots.
Also applies to: 113-120
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.mdx` around lines 61 - 105, The new onboarding screenshots in deploy-and-configure-unraid-os.mdx are referenced from the global /img bucket; move those image files into a local assets/ directory adjacent to this MDX and update the references in this file (e.g., change "/img/onboarding_step1.png" etc.) to relative paths or imported asset variables (for example "./assets/onboarding_step1.png" or import onboardingStep1 from './assets/onboarding_step1.png' and use {onboardingStep1}) so the images are colocated with the document and follow the contributor checklist; apply the same change for all other new onboarding/registration screenshots referenced in the file (including the ones noted in the comment).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In
`@docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.mdx`:
- Around line 53-57: The callout header text is inconsistent with the body;
update the note tag label from "Unraid 7.3 only" to match the body wording
(e.g., "Unraid 7.3 and later") by changing :::note[Unraid 7.3 only] to
:::note[Unraid 7.3 and later] so the callout and the sentence "The onboarding
wizard below applies to Unraid 7.3 and later." are consistent.
---
Duplicate comments:
In
`@docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.mdx`:
- Around line 107-127: The "Register your license key" section currently points
users to the older "Get Started" flow (mentions %%WebGUI|web-gui%% and "Get
Started") but doesn't state whether it applies to 7.3+; update the section to
either (A) add the 7.3+ registration entry point after the onboarding flow
(describe where to find license registration in 7.3+ and update
screenshots/labels accordingly), or (B) explicitly mark this section as "Legacy
(7.2 and earlier)" and link to the new 7.3+ onboarding documentation; update the
heading or callout text (the "Register your license key" heading, the "Get
Started" references, and the "Tools → Registration" note) so readers have a
clear handoff for current-version users.
---
Nitpick comments:
In
`@docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.mdx`:
- Around line 61-105: The new onboarding screenshots in
deploy-and-configure-unraid-os.mdx are referenced from the global /img bucket;
move those image files into a local assets/ directory adjacent to this MDX and
update the references in this file (e.g., change "/img/onboarding_step1.png"
etc.) to relative paths or imported asset variables (for example
"./assets/onboarding_step1.png" or import onboardingStep1 from
'./assets/onboarding_step1.png' and use {onboardingStep1}) so the images are
colocated with the document and follow the contributor checklist; apply the same
change for all other new onboarding/registration screenshots referenced in the
file (including the ones noted in the comment).
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 1c7ce9be-d66d-4ed2-878e-ad29d434e3c6
📒 Files selected for processing (1)
docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.mdx
Comment on lines
+53
to
+57
| :::note[Unraid 7.3 only] | ||
|
|
||
| The onboarding wizard below applies to Unraid 7.3 and later. | ||
|
|
||
| ::: |
Contributor
There was a problem hiding this comment.
Make the version callout consistent.
Line 53 says “Unraid 7.3 only”, but Line 55 says the wizard applies to “7.3 and later.” Those scopes conflict; please rename the note to match the broader wording.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In
`@docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.mdx`
around lines 53 - 57, The callout header text is inconsistent with the body;
update the note tag label from "Unraid 7.3 only" to match the body wording
(e.g., "Unraid 7.3 and later") by changing :::note[Unraid 7.3 only] to
:::note[Unraid 7.3 and later] so the callout and the sentence "The onboarding
wizard below applies to Unraid 7.3 and later." are consistent.
elibosley
force-pushed
the
feature/internal-boot
branch
from
36eb5cc to
88fdb43
Compare
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.mdx (1)
53-57:⚠️ Potential issue | 🟡 MinorMake the version callout consistent.
Line 53 says "Unraid 7.3 only", but Line 55 says the wizard applies to "7.3 and later." These scopes conflict.
-:::note[Unraid 7.3 only] +:::note[Unraid 7.3 and later] The onboarding wizard below applies to Unraid 7.3 and later.,
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.mdx` around lines 53 - 57, The callout label ":::note[Unraid 7.3 only]" conflicts with the following sentence "The onboarding wizard below applies to Unraid 7.3 and later." Update one of them so both state the same scope: either change the callout label to ":::note[Unraid 7.3 and later]" to match the sentence, or change the sentence to "The onboarding wizard below applies to Unraid 7.3 only." Make the edit in the deploy-and-configure-unraid-os.mdx file by updating the text inside the callout tag or the sentence accordingly.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In
`@docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.mdx`:
- Around line 142-159: Normalize the leading spaces for all checklist lines so
indentation is consistent: remove the extra leading spaces before "Set the USB
flash drive as the primary boot device", "Configure the storage controller to
**%%AHCI|ahci%%** mode with SATA connections", "Set the controller to **%%HBA
mode|hba-mode%%** (not **%%RAID|raid%%**)", "Disable **Secure Boot** as it is
not supported by Unraid OS", the Advanced Settings items such as "Enable
**%%hardware virtualization|hvm%%** features" and "Enable **%%IOMMU|iommu%%**
support", and the Troubleshooting Tips lines like "Adjusting the boot order to:
**Forced-FDD**, **USB-HDD**, **USB-ZIP**", ensuring every checklist line uses
the same leading whitespace (either none or one space) so rendered indentation
is uniform.
---
Duplicate comments:
In
`@docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.mdx`:
- Around line 53-57: The callout label ":::note[Unraid 7.3 only]" conflicts with
the following sentence "The onboarding wizard below applies to Unraid 7.3 and
later." Update one of them so both state the same scope: either change the
callout label to ":::note[Unraid 7.3 and later]" to match the sentence, or
change the sentence to "The onboarding wizard below applies to Unraid 7.3 only."
Make the edit in the deploy-and-configure-unraid-os.mdx file by updating the
text inside the callout tag or the sentence accordingly.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: a07a4d44-7f69-49e0-b398-83685b22132b
⛔ Files ignored due to path filters (7)
static/img/onboarding_step1.pngis excluded by!**/*.pngstatic/img/onboarding_step2.pngis excluded by!**/*.pngstatic/img/onboarding_step3a.pngis excluded by!**/*.pngstatic/img/onboarding_step3b.pngis excluded by!**/*.pngstatic/img/onboarding_step4.pngis excluded by!**/*.pngstatic/img/onboarding_step5.pngis excluded by!**/*.pngstatic/img/onboarding_step6.pngis excluded by!**/*.png
📒 Files selected for processing (1)
docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.mdx
Comment on lines
+142
to
+159
| ✅ Set the USB flash drive as the primary boot device.\ | ||
| ✅ Configure the storage controller to **%%AHCI|ahci%%** mode with SATA connections.\ | ||
| ✅ Set the controller to **%%HBA mode|hba-mode%%** (not **%%RAID|raid%%**).\ | ||
| ✅ Disable **Secure Boot** as it is not supported by Unraid OS. | ||
|
|
||
| ### Advanced Settings | ||
| ### Advanced Settings | ||
|
|
||
| ✅ Enable **%%hardware virtualization|hvm%%** features (e.g., **%%Intel VT-x|intel-vt-x%%** or **%%AMD-V|amd-v%%**) for **%%virtual machines (VMs)|vm%%**.\ | ||
| ✅ Enable **%%IOMMU|iommu%%** support (Intel VT-d or AMD-Vi) for PCI device assignment to VMs. | ||
| ✅ Enable **%%hardware virtualization|hvm%%** features (e.g., **%%Intel VT-x|intel-vt-x%%** or **%%AMD-V|amd-v%%**) for **%%virtual machines (VMs)|vm%%**.\ | ||
| ✅ Enable **%%IOMMU|iommu%%** support (Intel VT-d or AMD-Vi) for PCI device assignment to VMs. | ||
|
|
||
| ### Troubleshooting Tips | ||
| ### Troubleshooting Tips | ||
|
|
||
| If Unraid OS does not boot, try: | ||
| If Unraid OS does not boot, try: | ||
|
|
||
| ✅ Adjusting the boot order to: **Forced-FDD**, **USB-HDD**, **USB-ZIP**.\ | ||
| ✅ Disabling USB 2.0/3.0 support.\ | ||
| ✅ Toggling any Fast Boot features.\ | ||
| ✅ Toggling USB keyboard support. | ||
| ✅ Adjusting the boot order to: **Forced-FDD**, **USB-HDD**, **USB-ZIP**.\ | ||
| ✅ Disabling USB 2.0/3.0 support.\ | ||
| ✅ Toggling any Fast Boot features.\ | ||
| ✅ Toggling USB keyboard support. |
Contributor
There was a problem hiding this comment.
Inconsistent leading spaces in checklist items.
Some checkmark items have a leading space (lines 143-145, 150, 157-159) while others don't (lines 142, 149, 154, 156). This creates inconsistent indentation in the rendered output.
✅ Set the USB flash drive as the primary boot device.\
- ✅ Configure the storage controller to **%%AHCI|ahci%%** mode with SATA connections.\
- ✅ Set the controller to **%%HBA mode|hba-mode%%** (not **%%RAID|raid%%**).\
- ✅ Disable **Secure Boot** as it is not supported by Unraid OS.
+✅ Configure the storage controller to **%%AHCI|ahci%%** mode with SATA connections.\
+✅ Set the controller to **%%HBA mode|hba-mode%%** (not **%%RAID|raid%%**).\
+✅ Disable **Secure Boot** as it is not supported by Unraid OS.
### Advanced Settings
✅ Enable **%%hardware virtualization|hvm%%** features (e.g., **%%Intel VT-x|intel-vt-x%%** or **%%AMD-V|amd-v%%**) for **%%virtual machines (VMs)|vm%%**.\
- ✅ Enable **%%IOMMU|iommu%%** support (Intel VT-d or AMD-Vi) for PCI device assignment to VMs.
+✅ Enable **%%IOMMU|iommu%%** support (Intel VT-d or AMD-Vi) for PCI device assignment to VMs.
### Troubleshooting Tips
If Unraid OS does not boot, try:
✅ Adjusting the boot order to: **Forced-FDD**, **USB-HDD**, **USB-ZIP**.\
- ✅ Disabling USB 2.0/3.0 support.\
- ✅ Toggling any Fast Boot features.\
- ✅ Toggling USB keyboard support.
+✅ Disabling USB 2.0/3.0 support.\
+✅ Toggling any Fast Boot features.\
+✅ Toggling USB keyboard support.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In
`@docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.mdx`
around lines 142 - 159, Normalize the leading spaces for all checklist lines so
indentation is consistent: remove the extra leading spaces before "Set the USB
flash drive as the primary boot device", "Configure the storage controller to
**%%AHCI|ahci%%** mode with SATA connections", "Set the controller to **%%HBA
mode|hba-mode%%** (not **%%RAID|raid%%**)", "Disable **Secure Boot** as it is
not supported by Unraid OS", the Advanced Settings items such as "Enable
**%%hardware virtualization|hvm%%** features" and "Enable **%%IOMMU|iommu%%**
support", and the Troubleshooting Tips lines like "Adjusting the boot order to:
**Forced-FDD**, **USB-HDD**, **USB-ZIP**", ensuring every checklist line uses
the same leading whitespace (either none or one space) so rendered indentation
is uniform.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Before Submitting This PR, Please Ensure You Have Completed The Following:
Summary by CodeRabbit