Skip to content

Clarify flash backup restore flow for internal boot#426

Open
elibosley wants to merge 1 commit intomainfrom
codex/docs-internal-boot-flash-backup
Open

Clarify flash backup restore flow for internal boot#426
elibosley wants to merge 1 commit intomainfrom
codex/docs-internal-boot-flash-backup

Conversation

@elibosley
Copy link
Member

@elibosley elibosley commented Mar 22, 2026

Summary

  • explain how to restore a flash backup when the server uses internal boot
  • document that users should restore to USB first, then switch to internal boot via the onboarding wizard
  • clarify that users do not manually place backup files into the internal boot partition

Validation

  • ran git diff --check

Summary by CodeRabbit

  • Documentation
    • Added detailed instructions for restoring flash backups to internal boot, including steps to boot from the restored USB drive and use the Onboarding Wizard to complete the internal boot configuration switch with automatic boot configuration copying.
    • Added FAQ entry clarifying flash backup compatibility with internal boot and proper restoration procedures to avoid manual file copying.

@elibosley elibosley requested a review from ljm42 March 22, 2026 16:46
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 22, 2026

📝 Walkthrough

Walkthrough

Two documentation files were updated to clarify flash backup and internal boot processes. A new subsection was added to explain restore steps when using internal boot, and a FAQ entry was created describing how flash backups work with internal boot configurations, including the role of the Onboarding Wizard.

Changes

Cohort / File(s) Summary
Flash Backup & Internal Boot Documentation
docs/unraid-connect/automated-flash-backup.mdx, docs/unraid-os/getting-started/set-up-unraid/internal-boot-faq.mdx
Added subsection detailing restore steps for internal boot (restore to USB, boot, switch via Onboarding Wizard) and new FAQ entry explaining flash backup workflow with internal boot, clarifying that manual extraction into internal boot partition is not required.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A flash backup dance, so graceful and spry,
Internal boot blooms as the docs clarify,
No extraction needed, just wizard's a-click,
The boot configuration moves swift and so quick,
Documentation hops, hopping along! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is incomplete. It lacks a checklist confirming compliance with the repository's documentation requirements (relative links, file naming, assets, duplicate PRs, build status). Complete the pre-submission checklist by verifying and checking off all five items required by the description template.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change—clarifying the flash backup restore flow for internal boot, which matches the changeset's focus.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/docs-internal-boot-flash-backup

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
docs/unraid-os/getting-started/set-up-unraid/internal-boot-faq.mdx (1)

68-69: Optionally name the USB Flash Creator action to reduce restore ambiguity.

Consider explicitly calling out Use custom here so users know exactly which restore path to choose in the creator UI.

✍️ Suggested wording tweak
-Restore the backup to a USB flash drive first using the [Unraid USB Flash Creator](https://unraid.net/download), then boot from that restored USB device.
+Restore the backup to a USB flash drive first using the [Unraid USB Flash Creator](https://unraid.net/download) (**Use custom**), then boot from that restored USB device.
Based on learnings, flash backup ZIPs are compatible with the USB Flash Creator’s **Use custom** option for restore.
🤖 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/internal-boot-faq.mdx` around
lines 68 - 69, Update the sentence that instructs users to restore backups with
the Unraid USB Flash Creator to explicitly tell them to choose the "Use custom"
restore path in the creator UI: modify the line "Restore the backup to a USB
flash drive first using the Unraid USB Flash Creator, then boot from that
restored USB device." to include "Use custom" (e.g., mention that flash backup
ZIPs are compatible with the USB Flash Creator’s "Use custom" option) so readers
know exactly which restore option to pick.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@docs/unraid-os/getting-started/set-up-unraid/internal-boot-faq.mdx`:
- Around line 68-69: Update the sentence that instructs users to restore backups
with the Unraid USB Flash Creator to explicitly tell them to choose the "Use
custom" restore path in the creator UI: modify the line "Restore the backup to a
USB flash drive first using the Unraid USB Flash Creator, then boot from that
restored USB device." to include "Use custom" (e.g., mention that flash backup
ZIPs are compatible with the USB Flash Creator’s "Use custom" option) so readers
know exactly which restore option to pick.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 0d3ac77c-1211-47d6-b158-025b12169c51

📥 Commits

Reviewing files that changed from the base of the PR and between 3ca142f and f750e9b.

📒 Files selected for processing (2)
  • docs/unraid-connect/automated-flash-backup.mdx
  • docs/unraid-os/getting-started/set-up-unraid/internal-boot-faq.mdx

@cloudflare-workers-and-pages
Copy link

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 f750e9b Commit Preview URL

Branch Preview URL
Mar 22 2026, 04:53 PM

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