Skip to content

Conversation

@ZAli01
Copy link
Contributor

@ZAli01 ZAli01 commented Nov 21, 2025

typo fix

Before Submitting This PR, Please Ensure You Have Completed The Following:

  1. Are internal links to wiki documents using relative file links?
  2. Are all new documentation files lowercase, with dash separated names (ex. unraid-os.mdx)?
  3. Are all assets (images, etc), located in an assets/ subfolder next to the .md/mdx files?
  4. Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  5. Is the build succeeding?

Summary by CodeRabbit

  • Documentation
    • Improved disk removal documentation with comprehensive step-by-step instructions for safely removing disks from your Unraid array using the Parity-preserve method. Enhanced guide now includes detailed procedures for unmounting disks, zeroing storage, resetting array configuration, unassigning disks, and verifying parity integrity to ensure data safety.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 21, 2025

📝 Walkthrough

Walkthrough

Documentation update to the Unraid disk removal guide, refining grammar in existing instructions and adding comprehensive new steps (5–12) for the Parity-preserve method, including unmount, disk zeroing, array reset, and parity verification procedures.

Changes

Cohort / File(s) Summary
Documentation updates
docs/unraid-os/using-unraid-to/manage-storage/array/removing-disks-from-array.mdx
Grammar correction: "then stops the array" → "then stop the array". Added 8 new steps to Parity-preserve method covering disk unmounting, zeroing with version-specific dd commands, array stopping/resetting, disk unassignment, parity validation, array restart, and optional parity check verification.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

  • Verify accuracy of dd commands for Unraid version 6.12+ and 6.11 compatibility
  • Confirm sequence of steps is correct for the disk removal workflow
  • Check for consistency with existing documentation style and terminology

Poem

🐰 A disk must go, so here's the way,
Unmount and zero, come what may,
Reset the config, start the dance,
Parity preserved—give it a chance! ✨

Pre-merge checks and finishing touches

❌ Failed checks (2 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title is vague and does not clearly convey the main changes; it merely states 'Update' to a file without describing what was updated. Use a more specific title that describes the actual change, such as 'Fix typo in removing-disks-from-array.mdx' or 'Add parity-preserve method steps to removing-disks-from-array.mdx'.
Description check ❓ Inconclusive The description states 'typo fix' but the summary shows substantial additions of steps 5-12 in the Parity-preserve method, which contradicts the characterization as a simple typo fix. Clarify whether this is a minor typo fix or a more substantial content addition; update the description to accurately reflect the scope of changes made.
✅ Passed checks (1 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

  • Provide your own instructions using the high_level_summary_instructions setting.
  • Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
  • Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

  1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
  2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
  3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
  4. 📊 Contributor Summary — Include a Markdown table showing contributions:
    | Contributor | Lines Added | Lines Removed | Files Changed |
  5. ✔️ Additional Notes — Add any extra reviewer context.
    Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.


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 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.

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/unraid-os/using-unraid-to/manage-storage/array/removing-disks-from-array.mdx (1)

65-77: Verify device naming conventions and UI element references.

The new steps (5–12) provide comprehensive instructions for the parity-preserve method. Before merging, confirm:

  1. Device naming: Verify that the disk device naming conventions are accurate:

    • Line 68: dd bs=1M if=/dev/zero of=/dev/mdXp1 for Unraid 6.12+
    • Line 69: dd bs=1M if=/dev/zero of=/dev/mdX for Unraid 6.11 and earlier

    These differ from typical Linux conventions (usually /dev/sdX or /dev/nvmeXnYp1). Confirm that Unraid uses the /dev/mdXpX naming for RAID arrays.

  2. UI element reference: Line 75 references "Parity is already valid" checkbox. Verify this matches the exact text and location in the current Unraid UI.

  3. Terminology: Line 62 uses "maintenance mode"—confirm this is the correct term used in the Unraid interface.

Additionally, consider enhancing the safety context: the dd command on line 68–69 is destructive and irreversible. While line 56 provides a general warning, you may want to add an inline note (e.g., before line 66) reminding users to triple-check the device name before executing the command.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 93f0d79 and 81f607f.

📒 Files selected for processing (1)
  • docs/unraid-os/using-unraid-to/manage-storage/array/removing-disks-from-array.mdx (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: deploy-preview
🔇 Additional comments (1)
docs/unraid-os/using-unraid-to/manage-storage/array/removing-disks-from-array.mdx (1)

62-62: Grammar improvement looks good.

The change from "then stops the array" to "then stop the array" correctly uses imperative mood, which is consistent with instructional writing style throughout the document.

@github-actions
Copy link
Contributor

PR Preview Action v1.6.3

🚀 View preview at
https://unraid.github.io/docs/pr-preview/pr-389/

Built to branch gh-pages at 2025-11-21 12:16 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@ljm42 ljm42 merged commit 4b3ebd0 into unraid:main Nov 24, 2025
3 checks passed
@ljm42
Copy link
Member

ljm42 commented Nov 24, 2025

thanks

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.

2 participants