Workinprogress #289
Workinprogress #289
Conversation
📝 WalkthroughWalkthroughThis update removes a large number of legacy and current documentation files across the Unraid OS documentation set, including API, account, connect, guides, FAQs, manuals, and user management sections. Simultaneously, it introduces new and reorganized documentation focused on getting started, Unraid OS features, ZFS storage, and category metadata, marking a significant documentation restructuring and modernization effort. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant DocsHome
participant Glossary
participant GettingStarted
participant ZFSGuide
User->>DocsHome: Visit documentation home page
DocsHome->>Glossary: Show tooltip for technical terms
User->>GettingStarted: Access "What is Unraid?" and setup guides
User->>ZFSGuide: Read new ZFS storage documentation
Possibly related PRs
Suggested reviewers
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 6
🧹 Nitpick comments (23)
docs/glossary.md (1)
1-4: Add placeholder content to the new glossary page.The file defines front matter (
idandtitle) but has no body content, resulting in an empty page. Please add an introductory paragraph or at least one sample term definition to prevent rendering a blank section.docs/unraid-os/getting-started/_category_.json (1)
3-3: Ensure consistent ordering across categories
You’ve added"position": 1here—please verify that all sibling_category_.jsonfiles also include and alignpositionvalues for predictable navigation order.docs/docs-home.md (1)
15-15: Remove placeholder greeting
The “Hi Larry” note should be replaced or removed before publishing to avoid leaving personal or temporary text in the landing page.docs/unraid-os/getting-started/unraid-net.md (2)
8-8: Consider adding a comma for clarity
Insert a comma after “services” to improve flow:-An Unraid.net account is your access point to Unraid’s online services including forums… +An Unraid.net account is your access point to Unraid’s online services, including forums…
20-20: Update indefinite article usage
Replace “a SSO system” with “an SSO system” for correct English grammar.docs/unraid-os/getting-started/explore-the-user-interface/key-features.md (2)
8-8: Add comma for readability
Insert a comma before “while” to separate clauses:-…common tasks while also offering… +…common tasks, while also offering…
16-16: Replace HTML underline tags with markdown
Use native markdown emphasis instead of<u>for consistency:-**Network Controls** - Enable <u>NIC bonding</u> and bridging… +**Network Controls** - Enable _NIC bonding_ and bridging…docs/unraid-os/getting-started/set-up-unraid/complete-your-post-setup-essentials.md (2)
27-27: Use correct preposition
Change “on the top-right corner” to “in the top-right corner”:-…icon at the top-right corner. +…icon in the top-right corner.
31-31: Hyphenate alt text for clarity
Adjust alt text to “Built-in Help” for grammatical correctness:- +docs/unraid-os/getting-started/set-up-unraid/create-your-bootable-media.md (4)
16-18: Use “installation” instead of “install” in headingsFor consistency and grammatical accuracy, update:
## Automated install method→## Automated installation method
36-38: Use “installation” instead of “install” in headingsSimilarly, rename:
## Manual install method→## Manual installation method
40-46: Normalize heading level and indentation inside manual methodInside “Manual installation method,” the subheadings use
####and are indented. For proper nesting and style consistency:
- Change
#### Prepare your USB device:→### Prepare your USB device(remove trailing colon)- Change
#### Download and extract:→### Download and extract(remove trailing colon)- Unindent these headings so they start at column 0
68-70: Specify language for code fenceThe Linux boot script block should specify its language for syntax highlighting:
- ``` + ```bashdocs/unraid-os/getting-started/explore-the-user-interface/tour-the-web-gui.md (2)
1-3: Add missingsidebar_labelin front matterTo ensure this page appears correctly in the sidebar navigation, include a label:
sidebar_position: 2 +sidebar_label: Tour the WebGUI
11-14: Convert underlined text into proper Markdown linksReferences like “Community Applications section” and “Extend with Community Applications” use
<u>…</u>without actual URLs. Replace these with real Markdown links pointing to the correct documentation pages to improve UX.Also applies to: 62-64
docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.md (1)
91-93: Remove unnecessary colon before list itemsIn the troubleshooting steps, drop the colon after “to” for cleaner prose:
- try: ✅ Adjusting the boot order to: **Forced-FDD**, **USB-HDD**, **USB-ZIP**. + try ✅ Adjusting the boot order to **Forced-FDD**, **USB-HDD**, **USB-ZIP**.docs/unraid-os/getting-started/set-up-unraid/customize-unraid-settings.md (2)
14-14: Rephrase informal toneRather than “Don’t forget – the WebGUI includes built-in help,” consider a more neutral prompt:
- Don't forget - the WebGUI includes built-in help. To access help… + Please note the WebGUI includes built-in help. To access help…
149-150: Add missing comma for readabilityIn the Syslog server description, insert a comma before “since”:
- which is useful for troubleshooting since Unraid clears the log… + which is useful for troubleshooting, since Unraid clears the log…docs/unraid-os/advanced-configurations/optimize-storage/zfs-storage.md (2)
6-7: Remove unused imports
The imports ofTabsandTabItemaren’t used anywhere in this document. Please remove lines 6–7 to avoid clutter and potential build warnings.
11-13: Validate admonition type
Docusaurus supports:::note,:::tip,:::info,:::caution, and:::danger, but:::importantmay not render as expected. Consider switching this block to:::infoor:::notefor consistency.docs/unraid-os/getting-started/what-is-unraid.md (3)
113-117: Use proper Markdown links for internal docs
The note currently reads<u>Using Unraid to > Run Docker Containers</u>. Replace this with a relative Markdown link to the actual guide, for example::::note For advanced Docker settings, check out [Using Unraid to Run Docker Containers](../docker/using-unraid-run-docker.md). :::
128-129: Fix the “here” link placeholder
The textavailable <u>here</u>has no href. Convert it to something like:…available [here](../requirements/virtualization-requirements.md).
187-190: Correct the VM guide link syntax
This reads<u>Using Unraid to > Create virtual machines</u>. Please turn it into a relative Markdown link, e.g.:For VM setup steps, check out [Create virtual machines](../virtualization/using-unraid-create-vms.md).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (139)
docs/account/assets/link-key-step-01.pngis excluded by!**/*.pngdocs/account/assets/link-key-step-02.pngis excluded by!**/*.pngdocs/account/assets/link-key-step-03.pngis excluded by!**/*.pngdocs/account/assets/link-key-step-04.pngis excluded by!**/*.pngdocs/connect/assets/Deep-linking.pngis excluded by!**/*.pngdocs/connect/assets/Dns_rebinding_error.pngis excluded by!**/*.pngdocs/connect/assets/Enabling_remote_access.pngis excluded by!**/*.pngdocs/connect/assets/Register-a-server-7f35552e.pngis excluded by!**/*.pngdocs/connect/assets/Remote-access-enable-card.pngis excluded by!**/*.pngdocs/connect/assets/Remote-access-enabled-static.pngis excluded by!**/*.pngdocs/connect/assets/Remote_access_settings.pngis excluded by!**/*.pngdocs/connect/assets/Screenshot_2023-02-28_at_12.28.24_PM.pngis excluded by!**/*.pngdocs/connect/assets/Screenshot_2023-04-24_at_1.01.20_PM.pngis excluded by!**/*.pngdocs/connect/assets/Screenshot_2023-04-24_at_1.39.53_PM.pngis excluded by!**/*.pngdocs/connect/assets/Screenshot_2023-04-24_at_1.44.03_PM.pngis excluded by!**/*.pngdocs/connect/assets/Screenshot_2023-04-24_at_1.44.16_PM.pngis excluded by!**/*.pngdocs/connect/assets/Sign-in-up-connect-975a8554.pngis excluded by!**/*.pngdocs/legacy/assets/Resize_vdisk_2_(using_diskpart_to_delete_recovery_partition).PNGis excluded by!**/*.pngdocs/legacy/assets/Resize_vdisk_3_(extend_partition_in_disk_management).PNGis excluded by!**/*.pngdocs/legacy/assets/Resize_vdisk_4_(partition_has_been_extended_in_disk_management).PNGis excluded by!**/*.pngdocs/unraid-os/assets/CA_Tile1.pngis excluded by!**/*.pngdocs/unraid-os/assets/Configuringarray1.pngis excluded by!**/*.pngdocs/unraid-os/assets/Drive_failure@2x.pngis excluded by!**/*.pngdocs/unraid-os/assets/Upc_install_trial_key.pngis excluded by!**/*.pngdocs/unraid-os/assets/toolbar.pngis excluded by!**/*.pngdocs/unraid-os/manual/securit 10000 y/assets/outgoing-proxy-manager.pngis excluded by!**/*.pngpackage-lock.jsonis excluded by!**/package-lock.jsonstatic/img/Add-device.pngis excluded by!**/*.pngstatic/img/Backup_flash_drive.pngis excluded by!**/*.pngstatic/img/Bios-virtualization1.pngis excluded by!**/*.pngstatic/img/Bios-virtualization2.jpgis excluded by!**/*.jpgstatic/img/Bios-virtualization3.JPGis excluded by!**/*.jpgstatic/img/Bios-virtualization4.pngis excluded by!**/*.pngstatic/img/BootMenu.jpgis excluded by!**/*.jpgstatic/img/Booting.jpgis excluded by!**/*.jpgstatic/img/Btrfs-raid1.jpgis excluded by!**/*.jpgstatic/img/CA_Tile1.pngis excluded by!**/*.pngstatic/img/CA_Tile2.pngis excluded by!**/*.pngstatic/img/Cache-pool.gifis excluded by!**/*.gifstatic/img/Change_install_iso.pngis excluded by!**/*.pngstatic/img/Check_button.PNGis excluded by!**/*.pngstatic/img/Code-icon.jpgis excluded by!**/*.jpgstatic/img/Configuringarray1.pngis excluded by!**/*.pngstatic/img/Confirmrebuild.pngis excluded by!**/*.pngstatic/img/Diagnostics.jpgis excluded by!**/*.jpgstatic/img/Disable_disk_defrag_-_step_1.PNGis excluded by!**/*.pngstatic/img/Disable_disk_defrag_-_step_2.pngis excluded by!**/*.pngstatic/img/Disable_disk_defrag_-_step_3.pngis excluded by!**/*.pngstatic/img/Disable_disk_defrag_-_step_4.pngis excluded by!**/*.pngstatic/img/Disable_fast_startup_-_step_1.pngis excluded by!**/*.pngstatic/img/Disable_fast_startup_-_step_2.pngis excluded by!**/*.pngstatic/img/Disable_fast_startup_-_step_3.pngis excluded by!**/*.pngstatic/img/Disable_windows_indexing_-_step_1.pngis excluded by!**/*.pngstatic/img/Disable_windows_indexing_-_step_2.pngis excluded by!**/*.pngstatic/img/Disable_windows_indexing_-_step_3.pngis excluded by!**/*.pngstatic/img/Disk-settings.pngis excluded by!**/*.pngstatic/img/Diskfailureindicator.pngis excluded by!**/*.pngstatic/img/Diskfailurenotification.pngis excluded by!**/*.pngstatic/img/Diskrebuildnotification.pngis excluded by!**/*.pngstatic/img/Docker-vs-VM@2x.pngis excluded by!**/*.pngstatic/img/Docker@2x.pngis excluded by!**/*.pngstatic/img/Docker_run.pngis excluded by!**/*.pngstatic/img/Dockerguide-controlling.pngis excluded by!**/*.pngstatic/img/Dockerguide-usingvolumes.pngis excluded by!**/*.pngstatic/img/Dont_use_windows_upgrade_assistant.pngis excluded by!**/*.pngstatic/img/Download.pngis excluded by!**/*.pngstatic/img/Drive_failure@2x.pngis excluded by!**/*.pngstatic/img/Drive_failure@500px.pngis excluded by!**/*.pngstatic/img/Dynamix.docker.manager.pngis excluded by!**/*.pngstatic/img/Enable_rdp_-_step_1.pngis excluded by!**/*.pngstatic/img/Enable_rdp_-_step_2.pngis excluded by!**/*.pngstatic/img/Enable_rdp_-_step_3.pngis excluded by!**/*.pngstatic/img/Help-icon.jpgis excluded by!**/*.jpgstatic/img/High-Water_Allocation_Method.JPGis excluded by!**/*.jpgstatic/img/High_performance_power_mode_-_step_1.pngis excluded by!**/*.pngstatic/img/High_performance_power_mode_-_step_2.pngis excluded by!**/*.pngstatic/img/History_button.PNGis excluded by!**/*.pngstatic/img/Ident.pngis excluded by!**/*.pngstatic/img/Invalidkey.pngis excluded by!**/*.pngstatic/img/Invalidormissingkey.pngis excluded by!**/*.pngstatic/img/KVM@2x.pngis excluded by!**/*.pngstatic/img/Level_0.JPGis excluded by!**/*.jpgstatic/img/Log-icon.pngis excluded by!**/*.pngstatic/img/Log-icon2.PNGis excluded by!**/*.pngstatic/img/Movie_Share.jpgis excluded by!**/*.jpgstatic/img/Movies_Share_Disk_View.JPGis excluded by!**/*.jpgstatic/img/Newconfig.pngis excluded by!**/*.pngstatic/img/No_parity@2x.pngis excluded by!**/*.pngstatic/img/No_parity_500px.pngis excluded by!**/*.pngstatic/img/Only_1_cpu_core_assigned.pngis excluded by!**/*.pngstatic/img/Parity@2x.pngis excluded by!**/*.pngstatic/img/Parity@500px.pngis excluded by!**/*.pngstatic/img/Replacekey.pngis excluded by!**/*.pngstatic/img/SMBSettings.pngis excluded by!**/*.pngstatic/img/Screen_Shot_2021-06-24_at_12.38.44_PM.pngis excluded by!**/*.pngstatic/img/Selectversion.pngis excluded by!**/*.pngstatic/img/Set_root_password.pngis excluded by!**/*.pngstatic/img/Split_level_1.JPGis excluded by!**/*.jpgstatic/img/Split_level_2.JPGis excluded by!**/*.jpgstatic/img/Split_level_3.JPGis excluded by!**/*.jpgstatic/img/Switch_toggle.pngis excluded by!**/*.pngstatic/img/Syslog-server-setup.jpgis excluded by!**/*.jpgstatic/img/Syslog-server.jpgis excluded by!**/*.jpgstatic/img/TimeMachineEditor.pngis excluded by!**/*.pngstatic/img/Timeremaining.pngis excluded by!**/*.pngstatic/img/Toomanydevices.pngis excluded by!**/*.pngstatic/img/Toomanywrong.pngis excluded by!**/*.pngstatic/img/Upc_get_started.pngis excluded by!**/*.pngstatic/img/Upc_install_trial_key.pngis excluded by!**/*.pngstatic/img/Upgrade-UPC.pngis excluded by!**/*.pngstatic/img/Usbcreator.pngis excluded by!**/*.pngstatic/img/User_shares_-_access@2x.pngis excluded by!**/*.pngstatic/img/User_shares_-_access@500px.pngis excluded by!**/*.pngstatic/img/User_shares_-_distribution@2x.pngis excluded by!**/*.pngstatic/img/User_shares_-_distribution@300px.pngis excluded by!**/*.pngstatic/img/User_shares_-_distribution@500px.pngis excluded by!**/*.pngstatic/img/Wireguard-help.pngis excluded by!**/*.pngstatic/img/Wireguard.pngis excluded by!**/*.pngstatic/img/account-options.pngis excluded by!**/*.pngstatic/img/activate.pngis excluded by!**/*.pngstatic/img/adduser.pngis excluded by!**/*.pngstatic/img/appstab.pngis excluded by!**/*.pngstatic/img/arrayoperation_start.pngis excluded by!**/*.pngstatic/img/ca.pngis excluded by!**/*.pngstatic/img/ca_installation.pngis excluded by!**/*.pngstatic/img/dashboard.pngis excluded by!**/*.pngstatic/img/date-time-new.pngis excluded by!**/*.pngstatic/img/date-time.pngis excluded by!**/*.pngstatic/img/disk-settings1.pngis excluded by!**/*.pngstatic/img/disk-settings2.pngis excluded by!**/*.pngstatic/img/diskselectionlogic.pngis excluded by!**/*.pngstatic/img/enable-bridging.pngis excluded by!**/*.pngstatic/img/eye-icon.pngis excluded by!**/*.pngstatic/img/feedback.pngis excluded by!**/*.pngstatic/img/filemanager.pngis excluded by!**/*.pngstatic/img/flashbackup.pngis excluded by!**/*.pngstatic/img/helpicon.pngis excluded by!**/*.pngstatic/img/icon-settings-cpupinning.pngis excluded by!**/*.pngstatic/img/infoicon.pngis excluded by!**/*.png
📒 Files selected for processing (107)
docs/API/_category_.json(0 hunks)docs/API/cli.md(0 hunks)docs/API/how-to-use-the-api.md(0 hunks)docs/API/index.md(0 hunks)docs/API/upcoming-features.md(0 hunks)docs/account/_category_.json(0 hunks)docs/account/account.md(0 hunks)docs/account/link-key.md(0 hunks)docs/connect/_category_.json(0 hunks)docs/connect/flash-backup.md(0 hunks)docs/connect/help.md(0 hunks)docs/connect/index.md(0 hunks)docs/connect/privacy.md(0 hunks)docs/connect/remote-access.md(0 hunks)docs/docs-home.md(1 hunks)docs/glossary.md(1 hunks)docs/legacy/Articles/dual-boot-unraid-and-windows.md(0 hunks)docs/legacy/Articles/expanding-windows-vm-vdisk-partitions.md(0 hunks)docs/legacy/Articles/upgrading-to-unraid-6.md(0 hunks)docs/legacy/FAQ/Parity.md(0 hunks)docs/legacy/FAQ/cache-disk.md(0 hunks)docs/legacy/FAQ/check-disk-filesystems.md(0 hunks)docs/legacy/FAQ/check-harddrive-speed.md(0 hunks)docs/legacy/FAQ/console.md(0 hunks)docs/legacy/FAQ/parity-swap-procedure.md(0 hunks)docs/legacy/FAQ/replacing-a-data-drive.md(0 hunks)docs/legacy/FAQ/replacing-multiple-data-drives.md(0 hunks)docs/legacy/FAQ/setting-up-cpu-and-board-temperature-sensing.md(0 hunks)docs/legacy/FAQ/setup-sleep-and-wake-on-lan.md(0 hunks)docs/legacy/FAQ/shrink-array.md(0 hunks)docs/legacy/FAQ/terminal-access.md(0 hunks)docs/legacy/FAQ/transferring-files-from-a-network-share-to-unraid.md(0 hunks)docs/legacy/FAQ/transferring-files-within-the-unraid-server.md(0 hunks)docs/legacy/FAQ/understanding-smart-reports.md(0 hunks)docs/legacy/FAQ/usb-flash-drive-preparation.md(0 hunks)docs/legacy/_category_.json(0 hunks)docs/unraid-os/advanced-configurations/_category_.json(1 hunks)docs/unraid-os/advanced-configurations/optimize-storage/_category_.json(1 hunks)docs/unraid-os/advanced-configurations/optimize-storage/zfs-storage.md(1 hunks)docs/unraid-os/faq/_category_.json(0 hunks)docs/unraid-os/faq/installation.md(0 hunks)docs/unraid-os/faq/licensing-faq.md(0 hunks)docs/unraid-os/faq/os-faq.md(0 hunks)docs/unraid-os/faq/redeem-license-activation-code.md(0 hunks)docs/unraid-os/getting-started/_category_.json(1 hunks)docs/unraid-os/getting-started/advanced-bios-config.md(0 hunks)docs/unraid-os/getting-started/considerations.md(0 hunks)docs/unraid-os/getting-started/explore-the-user-interface/_category_.json(1 hunks)docs/unraid-os/getting-started/explore-the-user-interface/key-features.md(1 hunks)docs/unraid-os/getting-started/explore-the-user-interface/tour-the-web-gui.md(1 hunks)docs/unraid-os/getting-started/getting-started.md(0 hunks)docs/unraid-os/getting-started/manual-install-method.md(0 hunks)docs/unraid-os/getting-started/quick-install-guide.md(0 hunks)docs/unraid-os/getting-started/set-up-unraid/_category_.json(1 hunks)docs/unraid-os/getting-started/set-up-unraid/complete-your-post-setup-essentials.md(1 hunks)docs/unraid-os/getting-started/set-up-unraid/configure-your-array.md(1 hunks)docs/unraid-os/getting-started/set-up-unraid/create-your-bootable-media.md(1 hunks)docs/unraid-os/getting-started/set-up-unraid/customize-unraid-settings.md(1 hunks)docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.md(1 hunks)docs/unraid-os/getting-started/unraid-net.md(1 hunks)docs/unraid-os/getting-started/what-is-unraid.md(1 hunks)docs/unraid-os/guides/_category_.json(0 hunks)docs/unraid-os/guides/configuring-time-machine.md(0 hunks)docs/unraid-os/guides/convert-windows-to-vm.md(0 hunks)docs/unraid-os/guides/physical-to-virtual.md(0 hunks)docs/unraid-os/guides/wol-setup-for-unraid.md(0 hunks)docs/unraid-os/guides/xen-to-kvm.md(0 hunks)docs/unraid-os/manual/_category_.json(0 hunks)docs/unraid-os/manual/additional-settings.md(0 hunks)docs/unraid-os/manual/applications.md(0 hunks)docs/unraid-os/manual/changing-the-flash-device.md(0 hunks)docs/unraid-os/manual/docker-management.md(0 hunks)docs/unraid-os/manual/multi-language.md(0 hunks)docs/unraid-os/manual/security/_category_.json(0 hunks)docs/unraid-os/manual/security/data-encryption.md(0 hunks)docs/unraid-os/manual/security/flash-drive.md(0 hunks)docs/unraid-os/manual/security/good-practices.md(0 hunks)docs/unraid-os/manual/security/outgoing-proxy-manager.md(0 hunks)docs/unraid-os/manual/security/secure-webgui-ssl.md(0 hunks)docs/unraid-os/manual/security/security.md(0 hunks)docs/unraid-os/manual/security/tailscale.md(0 hunks)docs/unraid-os/manual/security/vpn.md(0 hunks)docs/unraid-os/manual/shares/_category_.json(0 hunks)docs/unraid-os/manual/shares/create-a-share.md(0 hunks)docs/unraid-os/manual/shares/delete-a-share.md(0 hunks)docs/unraid-os/manual/shares/disk-shares.md(0 hunks)docs/unraid-os/manual/shares/network-access.md(0 hunks)docs/unraid-os/manual/shares/shares.md(0 hunks)docs/unraid-os/manual/shares/user-shares.md(0 hunks)docs/unraid-os/manual/tools.md(0 hunks)docs/unraid-os/manual/upgrade-instructions.md(0 hunks)docs/unraid-os/manual/users/_category_.json(0 hunks)docs/unraid-os/manual/users/create-user.md(0 hunks)docs/unraid-os/manual/users/manage-user.md(0 hunks)docs/unraid-os/manual/users/reset-password.md(0 hunks)docs/unraid-os/manual/users/users.md(0 hunks)docs/unraid-os/manual/vm/_category_.json(0 hunks)docs/unraid-os/manual/vm/vm-management.md(0 hunks)docs/unraid-os/manual/vm/vm-support.md(0 hunks)docs/unraid-os/manual/zfs/_category_.json(0 hunks)docs/unraid-os/manual/zfs/placeholder.md(0 hunks)docs/unraid-os/overview/_category_.json(0 hunks)docs/unraid-os/overview/application-server.md(0 hunks)docs/unraid-os/overview/nas.md(0 hunks)docs/unraid-os/overview/ui-reference.md(0 hunks)docs/unraid-os/overview/unraid-management.md(0 hunks)docs/unraid-os/overview/virtualization-host.md(0 hunks)
⛔ Files not processed due to max files limit (36)
- docs/unraid-os/overview/what-is-unraid.md
- docs/unraid-os/release-notes/7.0.0.md
- docs/unraid-os/release-notes/7.0.1.md
- docs/unraid-os/release-notes/7.1.0.md
- docs/unraid-os/release-notes/7.1.1.md
- docs/unraid-os/release-notes/7.1.2.md
- docs/unraid-os/system-administration/category.json
- docs/unraid-os/system-administration/monitor-performance/category.json
- docs/unraid-os/system-administration/monitor-performance/smart-reports-and-disk-health.md
- docs/unraid-os/system-administration/secure-your-server/category.json
- docs/unraid-os/system-administration/secure-your-server/secure-remote-access.md
- docs/unraid-os/system-administration/secure-your-server/secure-your-flash-drive.md
- docs/unraid-os/system-administration/secure-your-server/securing-your-connection.md
- docs/unraid-os/system-administration/secure-your-server/securing-your-data.md
- docs/unraid-os/system-administration/secure-your-server/security-fundamentals.md
- docs/unraid-os/system-administration/secure-your-server/user-management.md
- docs/unraid-os/troubleshooting/category.json
- docs/unraid-os/troubleshooting/boot-issues.md
- docs/unraid-os/troubleshooting/cache-issues.md
- docs/unraid-os/troubleshooting/crc-errors.md
- docs/unraid-os/troubleshooting/data-recovery.md
- docs/unraid-os/troubleshooting/diagnostics-information.md
- docs/unraid-os/troubleshooting/docker.md
- docs/unraid-os/troubleshooting/system-crash.md
- docs/unraid-os/troubleshooting/troubleshooting.md
- docs/unraid-os/troubleshooting/unclean-shutdowns.md
- docs/unraid-os/troubleshooting/windows-connection.md
- docs/unraid-os/using-unraid-to/category.json
- docs/unraid-os/using-unraid-to/create-virtual-machines/category.json
- docs/unraid-os/using-unraid-to/create-virtual-machines/other-vm-operating-systems.md
- docs/unraid-os/using-unraid-to/create-virtual-machines/overview-and-system-prep.md
- docs/unraid-os/using-unraid-to/create-virtual-machines/vm-setup.md
- docs/unraid-os/using-unraid-to/customize-your-experience/category.json
- docs/unraid-os/using-unraid-to/customize-your-experience/plugins.md
- docs/unraid-os/using-unraid-to/manage-storage/category.json
- docs/unraid-os/using-unraid-to/manage-storage/array-configuration.md
💤 Files with no reviewable changes (90)
- docs/unraid-os/manual/users/category.json
- docs/API/category.json
- docs/unraid-os/manual/security/category.json
- docs/connect/category.json
- docs/unraid-os/faq/category.json
- docs/unraid-os/manual/category.json
- docs/unraid-os/manual/vm/category.json
- docs/account/category.json
- docs/unraid-os/overview/category.json
- docs/unraid-os/manual/zfs/category.json
- docs/legacy/category.json
- docs/unraid-os/manual/security/security.md
- docs/unraid-os/manual/shares/create-a-share.md
- docs/unraid-os/manual/shares/category.json
- docs/unraid-os/manual/shares/delete-a-share.md
- docs/account/link-key.md
- docs/unraid-os/overview/unraid-management.md
- docs/unraid-os/guides/category.json
- docs/account/account.md
- docs/unraid-os/getting-started/considerations.md
- docs/unraid-os/manual/users/create-user.md
- docs/connect/index.md
- docs/unraid-os/manual/users/users.md
- docs/connect/privacy.md
- docs/API/upcoming-features.md
- docs/unraid-os/manual/multi-language.md
- docs/connect/help.md
- docs/legacy/FAQ/transferring-files-from-a-network-share-to-unraid.md
- docs/API/how-to-use-the-api.md
- docs/unraid-os/manual/shares/disk-shares.md
- docs/unraid-os/getting-started/manual-install-method.md
- docs/unraid-os/manual/security/flash-drive.md
- docs/unraid-os/faq/installation.md
- docs/unraid-os/faq/redeem-license-activation-code.md
- docs/unraid-os/manual/tools.md
- docs/unraid-os/manual/users/manage-user.md
- docs/unraid-os/overview/ui-reference.md
- docs/legacy/Articles/upgrading-to-unraid-6.md
- docs/unraid-os/manual/shares/shares.md
- docs/unraid-os/getting-started/advanced-bios-config.md
- docs/legacy/FAQ/check-harddrive-speed.md
- docs/API/index.md
- docs/unraid-os/manual/security/outgoing-proxy-manager.md
- docs/unraid-os/manual/security/secure-webgui-ssl.md
- docs/unraid-os/guides/xen-to-kvm.md
- docs/unraid-os/overview/virtualization-host.md
- docs/legacy/FAQ/console.md
- docs/API/cli.md
- docs/unraid-os/faq/os-faq.md
- docs/legacy/Articles/expanding-windows-vm-vdisk-partitions.md
- docs/legacy/FAQ/terminal-access.md
- docs/unraid-os/manual/users/reset-password.md
- docs/legacy/FAQ/transferring-files-within-the-unraid-server.md
- docs/unraid-os/faq/licensing-faq.md
- docs/unraid-os/manual/security/good-practices.md
- docs/legacy/FAQ/replacing-a-data-drive.md
- docs/connect/remote-access.md
- docs/unraid-os/guides/wol-setup-for-unraid.md
- docs/unraid-os/guides/convert-windows-to-vm.md
- docs/unraid-os/manual/security/tailscale.md
- docs/unraid-os/guides/configuring-time-machine.md
- docs/legacy/FAQ/parity-swap-procedure.md
- docs/unraid-os/manual/shares/network-access.md
- docs/legacy/FAQ/understanding-smart-reports.md
- docs/legacy/Articles/dual-boot-unraid-and-windows.md
- docs/unraid-os/getting-started/quick-install-guide.md
- docs/legacy/FAQ/setup-sleep-and-wake-on-lan.md
- docs/unraid-os/manual/zfs/placeholder.md
- docs/legacy/FAQ/Parity.md
- docs/legacy/FAQ/usb-flash-drive-preparation.md
- docs/legacy/FAQ/cache-disk.md
- docs/unraid-os/manual/additional-settings.md
- docs/legacy/FAQ/setting-up-cpu-and-board-temperature-sensing.md
- docs/connect/flash-backup.md
- docs/unraid-os/manual/upgrade-instructions.md
- docs/unraid-os/manual/changing-the-flash-device.md
- docs/unraid-os/manual/security/data-encryption.md
- docs/unraid-os/manual/docker-management.md
- docs/unraid-os/overview/nas.md
- docs/legacy/FAQ/replacing-multiple-data-drives.md
- docs/unraid-os/overview/application-server.md
- docs/unraid-os/guides/physical-to-virtual.md
- docs/unraid-os/getting-started/getting-started.md
- docs/legacy/FAQ/shrink-array.md
- docs/unraid-os/manual/security/vpn.md
- docs/unraid-os/manual/applications.md
- docs/unraid-os/manual/shares/user-shares.md
- docs/legacy/FAQ/check-disk-filesystems.md
- docs/unraid-os/manual/vm/vm-management.md
- docs/unraid-os/manual/vm/vm-support.md
🧰 Additional context used
🪛 LanguageTool
docs/docs-home.md
[style] ~15-~15: Consider using a different adjective to strengthen your wording.
Context: ...t functionality will look like. Have a great day!
(HAVE_A_NICE_DAY)
docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.md
[typographical] ~93-~93: Do not use a colon (:) before a series that is introduced by a preposition (‘to’). Remove the colon or add a noun or a noun phrase after the preposition.
Context: ...boot, try: ✅ Adjusting the boot order to: Forced-FDD, USB-HDD, *USB-ZIP...
(RP_COLON)
docs/unraid-os/getting-started/set-up-unraid/create-your-bootable-media.md
[grammar] ~16-~16: The word ‘install’ is not a noun.
Context: ...o format as FAT32. ::: ## Automated install method The automated installation meth...
(A_INSTALL)
[uncategorized] ~31-~31: Possible missing preposition found.
Context: ...gure your server's BIOS settings** - Set the boot device to the USB flash drive....
(AI_HYDRA_LEO_MISSING_TO)
[grammar] ~36-~36: The word ‘install’ is not a noun.
Context: ...to boot into Unraid OS. ## Manual install method The manual installation method ...
(A_INSTALL)
docs/unraid-os/getting-started/unraid-net.md
[uncategorized] ~8-~8: A comma might be missing here.
Context: ...ons, having an account provides several benefits such as streamlined license management,...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~10-~10: You might be missing the article “the” here.
Context: ...se builds, and enhanced support. #### Benefits of an Unraid.net account include: - *...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[misspelling] ~16-~16: This word is normally spelled as one.
Context: ...:** Enjoy secure login with options for multi-factor authentication (MFA). ### Your Accoun...
(EN_COMPOUNDS_MULTI_FACTOR)
[misspelling] ~20-~20: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...he Data that's Stored Unraid.net uses a SSO system at account.unraid.net for se...
(EN_A_VS_AN)
[misspelling] ~30-~30: This word is normally spelled as one.
Context: ...etails | Information for multi-factor authentication | | Google...
(EN_COMPOUNDS_MULTI_FACTOR)
docs/unraid-os/getting-started/set-up-unraid/complete-your-post-setup-essentials.md
[grammar] ~27-~27: The usual preposition to use with “corner” is “in”, not “on”. Did you mean “in the top-right corner”?
Context: ...he icon at the top-right corner. You can also toggle help on individual...
(ON_IN_THE_CORNER_2)
[uncategorized] ~35-~35: Possible missing preposition found.
Context: ...](/img/toolbar.png) ## Review security best practices Since your Unraid serve...
(AI_HYDRA_LEO_MISSING_OF)
docs/unraid-os/getting-started/explore-the-user-interface/key-features.md
[uncategorized] ~8-~8: Possible missing comma found.
Context: ...face provides basic controls for common tasks while also offering advanced tuning opt...
(AI_HYDRA_LEO_MISSING_COMMA)
[misspelling] ~16-~16: This expression is normally spelled as one or with a hyphen.
Context: ...le NIC bonding and bridging, set time servers, and configure additional network setti...
(EN_COMPOUNDS_TIME_SERVERS)
docs/unraid-os/getting-started/set-up-unraid/customize-unraid-settings.md
[style] ~13-~13: For a more polite and respectful tone, consider rephrasing with ‘please’.
Context: ...s](/img/toolbar_settings.png) Don't forget - the WebGUI includes built-in help. To...
(DONT_FORGET)
[uncategorized] ~25-~25: Possible missing article found.
Context: ...ontainer and is no longer accessible to Unraid OS. - You can pin cores without needing...
(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~150-~150: Possible missing comma found.
Context: ...es your system log, which is useful for troubleshooting since Unraid clears the log after each ...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/unraid-os/getting-started/what-is-unraid.md
[style] ~21-~21: Consider using a more concise synonym.
Context: ...hed Storage (NAS) device. It can handle a variety of drives, whether they connect through ID...
(A_VARIETY_OF)
[style] ~64-~64: To strengthen your wording, consider replacing the phrasal verb “leave out”.
Context: ...so customize these shares to include or leave out certain drives and decide how files are...
(OMIT_EXCLUDE)
[style] ~84-~84: Opting for a less wordy alternative here may improve the clarity of your writing.
Context: ...e pool with multiple drives. This setup not only increases storage space but also uses technologies like ZFS or BTRFS to provi...
(NOT_ONLY_ALSO)
[uncategorized] ~111-~111: Do not mix variants of the same word (‘pre-configure’ and ‘preconfigure’) within a single text.
Context: ...ker by providing access to thousands of pre-configured apps through Docker Hub and C...
(EN_WORD_COHERENCY)
docs/unraid-os/advanced-configurations/optimize-storage/zfs-storage.md
[uncategorized] ~44-~44: Possible missing comma found.
Context: ...specific backup or replication scenarios but is not a replacement for a full ZFS poo...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~89-~89: To elevate your writing, try using an alternative expression here.
Context: ...5. Assign disks to the pool (disk order does not matter). <div style={{ margin: 'auto', maxWid...
(MATTERS_RELEVANT)
[uncategorized] ~321-~321: The preposition ‘to’ seems more likely in this position.
Context: ...our original pool, including those used for support vdevs, to the pool slots. Unrai...
(AI_HYDRA_LEO_REPLACE_FOR_TO)
[style] ~374-~374: This phrasing can be wordy. For improved clarity, try opting for something more concise.
Context: ...ture isn't yet available in the WebGUI. For the time being, expand via the CLI or add new vdevs th...
(FOR_THE_TIME_BEING)
🪛 markdownlint-cli2 (0.17.2)
docs/unraid-os/getting-started/set-up-unraid/create-your-bootable-media.md
40-40: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
40-40: Headings must start at the beginning of the line
null
(MD023, heading-start-left)
40-40: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
46-46: Headings must start at the beginning of the line
null
(MD023, heading-start-left)
46-46: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
56-56: Headings must start at the beginning of the line
null
(MD023, heading-start-left)
56-56: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
60-60: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
62-62: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
64-64: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
65-65: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
66-66: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
67-67: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
68-68: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
docs/unraid-os/getting-started/unraid-net.md
10-10: Heading levels should only increment by one level at a time
Expected: h2; Actual: h4
(MD001, heading-increment)
10-10: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
docs/unraid-os/getting-started/what-is-unraid.md
19-19: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
137-137: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
139-139: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
141-141: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
143-143: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
145-145: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
147-147: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
149-149: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
151-151: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
docs/unraid-os/advanced-configurations/optimize-storage/zfs-storage.md
39-39: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
57-57: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
72-72: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
85-85: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
93-93: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
102-102: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
114-114: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
120-120: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
154-154: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
162-162: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
177-177: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
204-204: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
232-232: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
249-249: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
287-287: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
301-301: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
🔇 Additional comments (6)
docs/unraid-os/advanced-configurations/optimize-storage/_category_.json (1)
1-4: Category metadata is correctly specified.The JSON is valid and the
"label": "Optimize storage"plus"position": 1follow conventions. No syntax issues detected. Ensure that any sibling categories underadvanced-configurations/use distinctpositionvalues for proper ordering.docs/unraid-os/getting-started/explore-the-user-interface/_category_.json (1)
1-4: Category metadata is correctly specified.The
"label": "Explore the user interface"and"position": 4entries are well-formed. Confirm that other sibling directories undergetting-started/reserve non-conflicting positions to maintain the intended navigation order.docs/unraid-os/advanced-configurations/_category_.json (1)
1-4: Category metadata is correctly specified.The
"label": "Advanced configurations"and"position": 4lines are valid JSON and adhere to naming conventions. Verify that other top-level categories underunraid-os/use unique positions to avoid ordering conflicts.docs/unraid-os/getting-started/set-up-unraid/_category_.json (1)
1-4: Category metadata is correctly specified.The JSON keys
"label": "Set up Unraid"and"position": 3are valid and follow the expected pattern. Please double-check that sibling categories ingetting-started/maintain uniquepositionindices.docs/unraid-os/getting-started/_category_.json (1)
2-2: Approve updated category label
The new label “Getting started with Unraid” provides clearer context to users.docs/docs-home.md (1)
6-6: Verify Docusaurus tooltip plugin configuration
Make sure@lunaticmuch/docusaurus-terminologyis installed and registered in yourdocusaurus.config.js, otherwise the<Term>component won’t render.Run this to confirm:
#!/bin/bash grep -R "terminology" docusaurus.config.js
|
|
||
| ### [Unraid Connect](/connect/index.md) | ||
| Welcome! <Term popup="A standard interface mode for disk controllers that allows storage devices to communicate with your computer. In Unraid, AHCI mode is typically recommended for better compatibility." reference="\docs\terms\AHCI">AHCI</Term> |
There was a problem hiding this comment.
Fix tooltip reference path separators
Backslashes will break the link. Use forward slashes for a valid URL:
-<Term popup="A standard interface..." reference="\docs\terms\AHCI">AHCI</Term>
+<Term popup="A standard interface..." reference="/docs/terms/AHCI">AHCI</Term>📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Welcome! <Term popup="A standard interface mode for disk controllers that allows storage devices to communicate with your computer. In Unraid, AHCI mode is typically recommended for better compatibility." reference="\docs\terms\AHCI">AHCI</Term> | |
| Welcome! <Term popup="A standard interface mode for disk controllers that allows storage devices to communicate with your computer. In Unraid, AHCI mode is typically recommended for better compatibility." reference="/docs/terms/AHCI">AHCI</Term> |
🤖 Prompt for AI Agents
In docs/docs-home.md at line 13, the tooltip reference path uses backslashes
which break the link. Replace all backslashes in the reference attribute with
forward slashes to ensure the URL is valid and the tooltip works correctly.
|
|
||
| An Unraid.net account is your access point to Unraid’s online services, including forums, Unraid Connect, and license management. While it's not required for basic server functions, having an account provides several benefits such as streamlined license management, access to prerelease builds, and enhanced support. | ||
|
|
||
| #### Benefits of an Unraid.net account include: |
There was a problem hiding this comment.
Correct heading level and trailing punctuation
Heading jumps from # to #### and ends with a colon. Change to a second-level heading without the colon:
-#### Benefits of an Unraid.net account include:
+## Benefits of an Unraid.net account include📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| #### Benefits of an Unraid.net account include: | |
| ## Benefits of an Unraid.net account include |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~10-~10: You might be missing the article “the” here.
Context: ...se builds, and enhanced support. #### Benefits of an Unraid.net account include: - *...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
🪛 markdownlint-cli2 (0.17.2)
10-10: Heading levels should only increment by one level at a time
Expected: h2; Actual: h4
(MD001, heading-increment)
10-10: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
🤖 Prompt for AI Agents
In docs/unraid-os/getting-started/unraid-net.md at line 10, change the heading
from a fourth-level heading with a colon to a second-level heading without a
colon. Replace the current "#### Benefits of an Unraid.net account include:"
with a properly formatted second-level heading "## Benefits of an Unraid.net
account include" and remove the trailing colon.
|
|
||
| # Create your bootable media | ||
|
|
||
| Unraid OS is installed on a USB flash drive, which acts as the boot device for your server. You can create this bootable media using our recommended [Automated install method](./create-your-bootable-media.md#automated-install-method) with our **USB Flash Creator** tool or by following the [Manual installation method](./create-your-bootable-media.md#manual-install-method). In both cases, you will need a high-quality USB flash drive (between 4 and 32 GB) that has a unique GUID. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Use relative anchor links for intra-page navigation
The links to “Automated install method” and “Manual install method” currently reference the filename. Simplify to fragment identifiers for cleaner, more maintainable intra-page links (e.g., [Automated installation method](#automated-installation-method)).
🤖 Prompt for AI Agents
In docs/unraid-os/getting-started/set-up-unraid/create-your-bootable-media.md at
line 8, the links to "Automated install method" and "Manual installation method"
include the filename, which is unnecessary for intra-page navigation. Update
these links to use only fragment identifiers by removing the filename and
keeping just the anchor part (e.g., change from
./create-your-bootable-media.md#automated-install-method to
#automated-install-method) for cleaner and more maintainable links.
| After installing your registration key, the next step is configuring your storage by assigning devices to the **array** and **pool devices**. This setup determines how Unraid OS manages your data, protects it with **parity**, and optimizes performance with **cache pools**. | ||
|
|
||
| :::important | ||
| If you're struggling with any part of the Unraid installation, be sure to check out our [Installation FAQ](https://docs.unraid.net/unraid-os/faq/installation/)! |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Replace absolute URL with a relative link
The Installation FAQ link currently points to the full domain. Switch to a relative path to keep all internal links consistent:
- [Installation FAQ](https://docs.unraid.net/unraid-os/faq/installation/)
+ [Installation FAQ](../../../faq/installation/)Committable suggestion skipped: line range outside the PR's diff.
🤖 Prompt for AI Agents
In docs/unraid-os/getting-started/set-up-unraid/configure-your-array.md at line
11, replace the absolute URL in the Installation FAQ link with a relative path
by removing the domain portion and keeping only the path starting from
/unraid-os/faq/installation/. This will ensure internal links remain consistent.
| If you forget your root password, you can reset it following the [Unraid documentation](https://docs.unraid.net/unraid-os/manual/security/reset-root-password/). You can also update your password in the Users page of the WebGUI. | ||
| ::: | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Use a relative link for the root password reset guide
Convert this absolute URL to an internal relative path:
- reset it following the [Unraid documentation](https://docs.unraid.net/unraid-os/manual/security/reset-root-password/)
+ reset it following the [Unraid documentation](../../manual/security/reset-root-password/)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| If you forget your root password, you can reset it following the [Unraid documentation](https://docs.unraid.net/unraid-os/manual/security/reset-root-password/). You can also update your password in the Users page of the WebGUI. | |
| ::: | |
| If you forget your root password, you can reset it following the [Unraid documentation](../../manual/security/reset-root-password/). You can also update your password in the Users page of the WebGUI. | |
| ::: |
🤖 Prompt for AI Agents
In
docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.md
around lines 42 to 44, replace the absolute URL linking to the root password
reset guide with a relative internal link pointing to the corresponding
documentation page within the docs site. This ensures consistency and proper
navigation within the documentation.
| <div style={{ margin: 'auto', maxWidth: '600px', display: 'flex', flexDirection: 'column', alignItems: 'center' }}> | ||
|
|
||
|  | ||
|
|
||
| </div> | ||
|
|
||
| - If you put all your disks into a large RAIDZ2 vdev, you can lose any two disks without losing data. However, expansion means adding another full vdev. | ||
| - You'll gain better parallel performance if you split disks into multiple smaller RAIDZ1 vdevs. Be cautious; if two disks fail in the same vdev, you will lose the whole pool. | ||
| - ZFS stripes data across vdevs, not individual disks, so more vdevs can lead to better performance for workloads with many small files or random I/O. | ||
| - Expanding a ZFS pool usually means adding a new vdev of the same layout, not just a single disk. | ||
|
|
||
| :::tip | ||
| Plan your pool’s layout to fit your needs and future growth. Unlike the Unraid array, you can’t add a single disk to an existing vdev using the WebGUI. | ||
| ::: | ||
|
|
||
| --- | ||
|
|
||
| ## Compression and RAM | ||
|
|
||
| ZFS offers advanced features that can significantly improve Unraid's storage efficiency and performance. Two common topics of interest are compression and memory requirements. | ||
|
|
||
| ZFS compression is **transparent** - it operates in the background, shrinking data before it reaches the disk. | ||
|
|
||
| This offers two major benefits: | ||
|
|
||
| - **Reduced disk usage:** Less storage space is consumed. | ||
| - **Improved performance:** Writing and reading less data can lead to faster operations, especially on modern CPUs. | ||
|
|
||
| <div style={{ margin: 'auto', maxWidth: '600px', display: 'flex', flexDirection: 'column', alignItems: 'center' }}> | ||
|
|
||
|  | ||
|
|
||
| </div> | ||
|
|
||
| :::tip | ||
| Enable ZFS compression for most Unraid ZFS pools. It's safe, efficient, and rarely impacts compatibility or stability. | ||
| ::: | ||
|
|
||
| <details> | ||
| <summary>The ZFS RAM Myth</summary> | ||
|
|
||
| You might have come across the outdated advice: “ZFS requires 1 GB of RAM per 1 TB of storage.” This is no longer applicable for most users. ZFS utilizes RAM for its Adaptive Replacement Cache (ARC), which speeds up frequently accessed reads. | ||
|
|
||
| Unraid automatically limits ZFS to using a reasonable portion of your system's RAM (usually 1/8th of total RAM). This allows ZFS to perform well without affecting Docker containers, VMs, or the Unraid OS. | ||
|
|
||
| <div style={{ margin: 'auto', maxWidth: '600px', display: 'flex', flexDirection: 'column', alignItems: 'center' }}> | ||
|
|
||
|  | ||
|
|
||
| </div> | ||
|
|
||
| </details> | ||
|
|
||
| :::info | ||
| ZFS scales well with available memory. More RAM can enhance cache performance, but ZFS functions reliably with modest hardware. Don’t let old recommendations prevent you from using ZFS on Unraid. | ||
| ::: | ||
|
|
||
| --- | ||
|
|
||
| ## Importing ZFS pools created on other systems | ||
|
|
||
| Unraid can import ZFS pools created on other platforms with minimal hassle. | ||
|
|
||
| <details> | ||
| <summary><strong>How to import a ZFS pool</strong></summary> | ||
|
|
||
| 1. **Stop the array:** Ensure your Unraid array is stopped. | ||
| 2. **Add new pool:** Click **Add Pool**. | ||
| 3. **Assign all drives:** | ||
| - Set **Number of Data Slots** to the total number of drives in your ZFS pool (including data vdevs and support vdevs). | ||
| - Assign each drive to the correct slot. | ||
| - _Example:_ For a pool with a 4-drive mirrored vdev and a 2-drive L2ARC vdev, set 6 slots and assign all six drives. | ||
| 4. **Set file system to "Auto":** Click the pool name (e.g., `raptor`) and set **File System** to **Auto**. | ||
| 5. **Finish and start array:** Click **Done**, then start the array. | ||
|
|
||
| :::info Automatic detection | ||
| Unraid will automatically detect and import the ZFS pool. Support vdevs (like log, cache/L2ARC, special/dedup) are listed under **Subpools** in the WebGUI. There is no need to add subpools during import manually. | ||
| ::: | ||
|
|
||
| After importing, running a **scrub** is highly recommended to verify data integrity. | ||
|
|
||
| - Click the pool name (e.g., `raptor`) to open its configuration. | ||
| - Under **Pool Status**, check the status and click **Scrub**. | ||
| <div style={{ margin: 'auto', maxWidth: '600px', display: 'flex', flexDirection: 'column', alignItems: 'center' }}> | ||
|
|
||
|  | ||
|
|
||
| </div> | ||
|
|
||
| </details> | ||
|
|
||
| --- | ||
|
|
||
| ## Support vdevs (subpools) | ||
|
|
||
| Unraid refers to ZFS support vdevs as **subpools**. Most users do **not** need these, but advanced users may encounter them: | ||
|
|
||
| <div style={{ margin: 'auto', maxWidth: '600px', display: 'flex', flexDirection: 'column', alignItems: 'center' }}> | ||
|
|
||
|  |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add descriptive alt text and relocate assets
All of the  image references are missing alt text, and according to our docs guidelines assets should live in an assets/ folder adjacent to this file. Please:
- Move each
/img/*.pngintodocs/unraid-os/advanced-configurations/optimize-storage/assets/ - Update the links to use relative paths, e.g.
 - Provide meaningful alt text for every image
🧰 Tools
🪛 LanguageTool
[uncategorized] ~44-~44: Possible missing comma found.
Context: ...specific backup or replication scenarios but is not a replacement for a full ZFS poo...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~89-~89: To elevate your writing, try using an alternative expression here.
Context: ...5. Assign disks to the pool (disk order does not matter). <div style={{ margin: 'auto', maxWid...
(MATTERS_RELEVANT)
🪛 markdownlint-cli2 (0.17.2)
39-39: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
57-57: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
72-72: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
85-85: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
93-93: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
102-102: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
114-114: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
120-120: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
154-154: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
162-162: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
177-177: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
204-204: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
232-232: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
249-249: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
287-287: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
301-301: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
🤖 Prompt for AI Agents
In docs/unraid-os/advanced-configurations/optimize-storage/zfs-storage.md
between lines 39 and 301, all image references use the /img/ path without alt
text, which violates documentation guidelines. Move each referenced image from
/img/*.png to docs/unraid-os/advanced-configurations/optimize-storage/assets/,
update all image links to relative paths like ./assets/filename.png, and add
meaningful descriptive alt text to every image markdown tag.
777c389 to
0cc87e6
Compare
|
@grizzlechips - to ensure your branch is up to date, please pull with |
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (4)
docs/docs-home.md (1)
13-13: Fix tooltip reference path separatorsBackslashes in the
referenceattribute will break the link. Use forward slashes for a valid URL, e.g.:- reference="\\docs\\terms\\AHCI" + reference="/docs/terms/AHCI"docs/unraid-os/getting-started/unraid-net.md (1)
10-10: Correct heading level and remove trailing punctuationChange this from a fourth-level heading with a colon to a second-level heading without a colon (e.g.,
## Benefits of an Unraid.net account include).docs/unraid-os/getting-started/set-up-unraid/create-your-bootable-media.md (1)
8-8: Use fragment-only intra-page links
The links at line 8 include the filename in the anchor but you can simplify to just the fragment (e.g.,#automated-install-method).docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.md (1)
42-44: Use a relative internal link for password reset
Convert the absolute URL to an internal relative path to maintain consistency.- If you forget your root password, you can reset it following the [Unraid documentation](https://docs.unraid.net/unraid-os/manual/security/reset-root-password/). + If you forget your root password, you can reset it following the [Unraid documentation](../../manual/security/reset-root-password/).
🧹 Nitpick comments (10)
docs/docs-home.md (1)
15-15: Refine closing remark toneConsider aligning the sign-off “Have a great day!” with the documentation’s professional style or removing the personal note.
docs/unraid-os/advanced-configurations/optimize-storage/zfs-storage.md (1)
6-7: Remove or utilize imported componentsThe
TabsandTabItemimports are not used in this file. Remove them or implement the intended tabbed sections.docs/unraid-os/getting-started/set-up-unraid/complete-your-post-setup-essentials.md (1)
27-27: Preposition in admonition needs adjustmentReplace “on the top-right corner” with “in the top-right corner” for accuracy.
docs/unraid-os/getting-started/set-up-unraid/create-your-bootable-media.md (4)
16-16: Use “installation” instead of “install”
The heading “Automated install method” should read “Automated installation method” for proper noun usage.- ## Automated install method + ## Automated installation method
36-36: Use “installation” instead of “install”
The heading “Manual install method” should read “Manual installation method” for proper noun usage.- ## Manual install method + ## Manual installation method
40-46: Normalize heading levels and remove trailing colons
The subsections under “Manual installation method” use level 4 headings with trailing colons. They should be level 3 without a colon.- #### Prepare your USB device: + ### Prepare your USB device ... - #### Download and extract: + ### Download and extract
68-70: Specify language for fenced code block
The code block formake_bootable_linuxlacks a language specifier. Addingbash(orshell) improves readability.- ``` + ```bashdocs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.md (2)
43-43: Preposition in “Users page”
Change “update your password in the Users page” to “update your password on the Users page” for correct preposition use.- You can also update your password in the Users page of the WebGUI. + You can also update your password on the Users page of the WebGUI.
91-93: Remove unnecessary colon before list
The sentence “If Unraid OS does not boot, try:” doesn’t require a colon.- If Unraid OS does not boot, try: + If Unraid OS does not boot, trydocs/unraid-os/getting-started/set-up-unraid/customize-unraid-settings.md (1)
14-14: Polish tone in reminder
Replace “Don't forget - the WebGUI includes built-in help.” with a more courteous phrasing.- Don't forget - the WebGUI includes built-in help. + Please remember that the WebGUI includes built-in help.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (141)
docs/account/assets/link-key-step-01.pngis excluded by!**/*.pngdocs/account/assets/link-key-step-02.pngis excluded by!**/*.pngdocs/account/assets/link-key-step-03.pngis excluded by!**/*.pngdocs/account/assets/link-key-step-04.pngis excluded by!**/*.pngdocs/connect/assets/Deep-linking.pngis excluded by!**/*.pngdocs/connect/assets/Dns_rebinding_error.pngis excluded by!**/*.pngdocs/connect/assets/Enabling_remote_access.pngis excluded by!**/*.pngdocs/connect/assets/Register-a-server-7f35552e.pngis excluded by!**/*.pngdocs/connect/assets/Remote-access-enable-card.pngis excluded by!**/*.pngdocs/connect/assets/Remote-access-enabled-static.pngis excluded by!**/*.pngdocs/connect/assets/Remote_access_settings.pngis excluded by!**/*.pngdocs/connect/assets/Screenshot_2023-02-28_at_12.28.24_PM.pngis excluded by!**/*.pngdocs/connect/assets/Screenshot_2023-04-24_at_1.01.20_PM.pngis excluded by!**/*.pngdocs/connect/assets/Screenshot_2023-04-24_at_1.39.53_PM.pngis excluded by!**/*.pngdocs/connect/assets/Screenshot_2023-04-24_at_1.44.03_PM.pngis excluded by!**/*.pngdocs/connect/assets/Screenshot_2023-04-24_at_1.44.16_PM.pngis excluded by!**/*.pngdocs/connect/assets/Sign-in-up-connect-975a8554.pngis excluded by!**/*.pngdocs/legacy/assets/Resize_vdisk_2_(using_diskpart_to_delete_recovery_partition).PNGis excluded by!**/*.pngdocs/legacy/assets/Resize_vdisk_3_(extend_partition_in_disk_management).PNGis excluded by!**/*.pngdocs/legacy/assets/Resize_vdisk_4_(partition_has_been_extended_in_disk_management).PNGis excluded by!**/*.pngdocs/unraid-os/assets/CA_Tile1.pngis excluded by!**/*.pngdocs/unraid-os/assets/Configuringarray1.pngis excluded by!**/*.pngdocs/unraid-os/assets/Drive_failure@2x.pngis excluded by!**/*.pngdocs/unraid-os/assets/Upc_install_trial_key.pngis excluded by!**/*.pngdocs/unraid-os/assets/toolbar.pngis excluded by!**/*.pngdocs/unraid-os/manual/security/assets/outgoing-proxy-manager.pngis excluded by!**/*.pngpackage-lock.jsonis excluded by!**/package-lock.jsonstatic/img/Add-device.pngis excluded by!**/*.pngstatic/img/Backup_flash_drive.pngis excluded by!**/*.pngstatic/img/Bios-virtualization1.pngis excluded by!**/*.pngstatic/img/Bios-virtualization2.jpgis excluded by!**/*.jpgstatic/img/Bios-virtualization3.JPGis excluded by!**/*.jpgstatic/img/Bios-virtualization4.pngis excluded by!**/*.pngstatic/img/BootMenu.jpgis excluded by!**/*.jpgstatic/img/Booting.jpgis excluded by!**/*.jpgstatic/img/Btrfs-raid1.jpgis excluded by!**/*.jpgstatic/img/CA_Tile1.pngis excluded by!**/*.pngstatic/img/CA_Tile2.pngis excluded by!**/*.pngstatic/img/Cache-pool.gifis excluded by!**/*.gifstatic/img/Change_install_iso.pngis excluded by!**/*.pngstatic/img/Check_button.PNGis excluded by!**/*.pngstatic/img/Code-icon.jpgis excluded by!**/*.jpgstatic/img/Configuringarray1.pngis excluded by!**/*.pngstatic/img/Confirmrebuild.pngis excluded by!**/*.pngstatic/img/Diagnostics.jpgis excluded by!**/*.jpgstatic/img/Disable_disk_defrag_-_step_1.PNGis excluded by!**/*.pngstatic/img/Disable_disk_defrag_-_step_2.pngis excluded by!**/*.pngstatic/img/Disable_disk_defrag_-_step_3.pngis excluded by!**/*.pngstatic/img/Disable_disk_defrag_-_step_4.pngis excluded by!**/*.pngstatic/img/Disable_fast_startup_-_step_1.pngis excluded by!**/*.pngstatic/img/Disable_fast_startup_-_step_2.pngis excluded by!**/*.pngstatic/img/Disable_fast_startup_-_step_3.pngis excluded by!**/*.pngstatic/img/Disable_windows_indexing_-_step_1.pngis excluded by!**/*.pngstatic/img/Disable_windows_indexing_-_step_2.pngis excluded by!**/*.pngstatic/img/Disable_windows_indexing_-_step_3.pngis excluded by!**/*.pngstatic/img/Disk-settings.pngis excluded by!**/*.pngstatic/img/Diskfailureindicator.pngis excluded by!**/*.pngstatic/img/Diskfailurenotification.pngis excluded by!**/*.pngstatic/img/Diskrebuildnotification.pngis excluded by!**/*.pngstatic/img/Docker-vs-VM@2x.pngis excluded by!**/*.pngstatic/img/Docker@2x.pngis excluded by!**/*.pngstatic/img/Docker_run.pngis excluded by!**/*.pngstatic/img/Dockerguide-controlling.pngis excluded by!**/*.pngstatic/img/Dockerguide-usingvolumes.pngis excluded by!**/*.pngstatic/img/Dont_use_windows_upgrade_assistant.pngis excluded by!**/*.pngstatic/img/Download.pngis excluded by!**/*.pngstatic/img/Drive_failure@2x.pngis excluded by!**/*.pngstatic/img/Drive_failure@500px.pngis excluded by!**/*.pngstatic/img/Dynamix.docker.manager.pngis excluded by!**/*.pngstatic/img/Enable_rdp_-_step_1.pngis excluded by!**/*.pngstatic/img/Enable_rdp_-_step_2.pngis excluded by!**/*.pngstatic/img/Enable_rdp_-_step_3.pngis excluded by!**/*.pngstatic/img/Help-icon.jpgis excluded by!**/*.jpgstatic/img/High-Water_Allocation_Method.JPGis excluded by!**/*.jpgstatic/img/High_performance_power_mode_-_step_1.pngis excluded by!**/*.pngstatic/img/High_performance_power_mode_-_step_2.pngis excluded by!**/*.pngstatic/img/History_button.PNGis excluded by!**/*.pngstatic/img/Ident.pngis excluded by!**/*.pngstatic/img/Invalidkey.pngis excluded by!**/*.pngstatic/img/Invalidormissingkey.pngis excluded by!**/*.pngstatic/img/KVM@2x.pngis excluded by!**/*.pngstatic/img/Level_0.JPGis excluded by!**/*.jpgstatic/img/Log-icon.pngis excluded by!**/*.pngstatic/img/Log-icon2.PNGis excluded by!**/*.pngstatic/img/Movie_Share.jpgis excluded by!**/*.jpgstatic/img/Movies_Share_Disk_View.JPGis excluded by!**/*.jpgstatic/img/Newconfig.pngis excluded by!**/*.pngstatic/img/No_parity@2x.pngis excluded by!**/*.pngstatic/img/No_parity_500px.pngis excluded by!**/*.pngstatic/img/Only_1_cpu_core_assigned.pngis excluded by!**/*.pngstatic/img/Parity@2x.pngis excluded by!**/*.pngstatic/img/Parity@500px.pngis excluded by!**/*.pngstatic/img/Replacekey.pngis excluded by!**/*.pngstatic/img/SMBSettings.pngis excluded by!**/*.pngstatic/img/Screen_Shot_2021-06-24_at_12.38.44_PM.pngis excluded by!**/*.pngstatic/img/Selectversion.pngis excluded by!**/*.pngstatic/img/Set_root_password.pngis excluded by!**/*.pngstatic/img/Split_level_1.JPGis excluded by!**/*.jpgstatic/img/Split_level_2.JPGis excluded by!**/*.jpgstatic/img/Split_level_3.JPGis excluded by!**/*.jpgstatic/img/Switch_toggle.pngis excluded by!**/*.pngstatic/img/Syslog-server-setup.jpgis excluded by!**/*.jpgstatic/img/Syslog-server.jpgis excluded by!**/*.jpgstatic/img/TimeMachineEditor.pngis excluded by!**/*.pngstatic/img/Timeremaining.pngis excluded by!**/*.pngstatic/img/Toomanydevices.pngis excluded by!**/*.pngstatic/img/Toomanywrong.pngis excluded by!**/*.pngstatic/img/Upc_get_started.pngis excluded by!**/*.pngstatic/img/Upc_install_trial_key.pngis excluded by!**/*.pngstatic/img/Upgrade-UPC.pngis excluded by!**/*.pngstatic/img/Usbcreator.pngis excluded by!**/*.pngstatic/img/User_shares_-_access@2x.pngis excluded by!**/*.pngstatic/img/User_shares_-_access@500px.pngis excluded by!**/*.pngstatic/img/User_shares_-_distribution@2x.pngis excluded by!**/*.pngstatic/img/User_shares_-_distribution@300px.pngis excluded by!**/*.pngstatic/img/User_shares_-_distribution@500px.pngis excluded by!**/*.pngstatic/img/Wireguard-help.pngis excluded by!**/*.pngstatic/img/Wireguard.pngis excluded by!**/*.pngstatic/img/account-options.pngis excluded by!**/*.pngstatic/img/activate.pngis excluded by!**/*.pngstatic/img/adduser.pngis excluded by!**/*.pngstatic/img/appstab.pngis excluded by!**/*.pngstatic/img/arrayoperation_start.pngis excluded by!**/*.pngstatic/img/ca.pngis excluded by!**/*.pngstatic/img/ca_installation.pngis excluded by!**/*.pngstatic/img/dashboard.pngis excluded by!**/*.pngstatic/img/date-time-new.pngis excluded by!**/*.pngstatic/img/date-time.pngis excluded by!**/*.pngstatic/img/disk-settings1.pngis excluded by!**/*.pngstatic/img/disk-settings2.pngis excluded by!**/*.pngstatic/img/diskselectionlogic.pngis excluded by!**/*.pngstatic/img/enable-bridging.pngis excluded by!**/*.pngstatic/img/eye-icon.pngis excluded by!**/*.pngstatic/img/feedback.pngis excluded by!**/*.pngstatic/img/filemanager.pngis excluded by!**/*.pngstatic/img/flashbackup.pngis excluded by!**/*.pngstatic/img/helpicon.pngis excluded by!**/*.pngstatic/img/icon-settings-cpupinning.pngis excluded by!**/*.pngstatic/img/infoicon.pngis excluded by!**/*.pngstatic/img/key.pngis excluded by!**/*.pngstatic/img/logicon.pngis excluded by!**/*.png
📒 Files selected for processing (107)
docs/API/_category_.json(0 hunks)docs/API/cli.md(0 hunks)docs/API/how-to-use-the-api.md(0 hunks)docs/API/index.md(0 hunks)docs/API/upcoming-features.md(0 hunks)docs/account/_category_.json(0 hunks)docs/account/account.md(0 hunks)docs/account/link-key.md(0 hunks)docs/connect/_category_.json(0 hunks)docs/connect/flash-backup.md(0 hunks)docs/connect/help.md(0 hunks)docs/connect/index.md(0 hunks)docs/connect/privacy.md(0 hunks)docs/connect/remote-access.md(0 hunks)docs/docs-home.md(1 hunks)docs/glossary.md(1 hunks)docs/legacy/Articles/dual-boot-unraid-and-windows.md(0 hunks)docs/legacy/Articles/expanding-windows-vm-vdisk-partitions.md(0 hunks)docs/legacy/Articles/upgrading-to-unraid-6.md(0 hunks)docs/legacy/FAQ/Parity.md(0 hunks)docs/legacy/FAQ/cache-disk.md(0 hunks)docs/legacy/FAQ/check-disk-filesystems.md(0 hunks)docs/legacy/FAQ/check-harddrive-speed.md(0 hunks)docs/legacy/FAQ/console.md(0 hunks)docs/legacy/FAQ/parity-swap-procedure.md(0 hunks)docs/legacy/FAQ/replacing-a-data-drive.md(0 hunks)docs/legacy/FAQ/replacing-multiple-data-drives.md(0 hunks)docs/legacy/FAQ/setting-up-cpu-and-board-temperature-sensing.md(0 hunks)docs/legacy/FAQ/setup-sleep-and-wake-on-lan.md(0 hunks)docs/legacy/FAQ/shrink-array.md(0 hunks)docs/legacy/FAQ/terminal-access.md(0 hunks)docs/legacy/FAQ/transferring-files-from-a-network-share-to-unraid.md(0 hunks)docs/legacy/FAQ/transferring-files-within-the-unraid-server.md(0 hunks)docs/legacy/FAQ/understanding-smart-reports.md(0 hunks)docs/legacy/FAQ/usb-flash-drive-preparation.md(0 hunks)docs/legacy/_category_.json(0 hunks)docs/unraid-os/advanced-configurations/_category_.json(1 hunks)docs/unraid-os/advanced-configurations/optimize-storage/_category_.json(1 hunks)docs/unraid-os/advanced-configurations/optimize-storage/zfs-storage.md(1 hunks)docs/unraid-os/faq/_category_.json(0 hunks)docs/unraid-os/faq/installation.md(0 hunks)docs/unraid-os/faq/licensing-faq.md(0 hunks)docs/unraid-os/faq/os-faq.md(0 hunks)docs/unraid-os/faq/redeem-license-activation-code.md(0 hunks)docs/unraid-os/getting-started/_category_.json(1 hunks)docs/unraid-os/getting-started/advanced-bios-config.md(0 hunks)docs/unraid-os/getting-started/considerations.md(0 hunks)docs/unraid-os/getting-started/explore-the-user-interface/_category_.json(1 hunks)docs/unraid-os/getting-started/explore-the-user-interface/key-features.md(1 hunks)docs/unraid-os/getting-started/explore-the-user-interface/tour-the-web-gui.md(1 hunks)docs/unraid-os/getting-started/getting-started.md(0 hunks)docs/unraid-os/getting-started/manual-install-method.md(0 hunks)docs/unraid-os/getting-started/quick-install-guide.md(0 hunks)docs/unraid-os/getting-started/set-up-unraid/_category_.json(1 hunks)docs/unraid-os/getting-started/set-up-unraid/complete-your-post-setup-essentials.md(1 hunks)docs/unraid-os/getting-started/set-up-unraid/configure-your-array.md(1 hunks)docs/unraid-os/getting-started/set-up-unraid/create-your-bootable-media.md(1 hunks)docs/unraid-os/getting-started/set-up-unraid/customize-unraid-settings.md(1 hunks)docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.md(1 hunks)docs/unraid-os/getting-started/unraid-net.md(1 hunks)docs/unraid-os/getting-started/what-is-unraid.md(1 hunks)docs/unraid-os/guides/_category_.json(0 hunks)docs/unraid-os/guides/configuring-time-machine.md(0 hunks)docs/unraid-os/guides/convert-windows-to-vm.md(0 hunks)docs/unraid-os/guides/physical-to-virtual.md(0 hunks)docs/unraid-os/guides/wol-setup-for-unraid.md(0 hunks)docs/unraid-os/guides/xen-to-kvm.md(0 hunks)docs/unraid-os/manual/_category_.json(0 hunks)docs/unraid-os/manual/additional-settings.md(0 hunks)docs/unraid-os/manual/applications.md(0 hunks)docs/unraid-os/manual/changing-the-flash-device.md(0 hunks)docs/unraid-os/manual/docker-management.md(0 hunks)docs/unraid-os/manual/multi-language.md(0 hunks)docs/unraid-os/manual/security/_category_.json(0 hunks)docs/unraid-os/manual/security/data-encryption.md(0 hunks)docs/unraid-os/manual/security/flash-drive.md(0 hunks)docs/unraid-os/manual/security/good-practices.md(0 hunks)docs/unraid-os/manual/security/outgoing-proxy-manager.md(0 hunks)docs/unraid-os/manual/security/secure-webgui-ssl.md(0 hunks)docs/unraid-os/manual/security/security.md(0 hunks)docs/unraid-os/manual/security/tailscale.md(0 hunks)docs/unraid-os/manual/security/vpn.md(0 hunks)docs/unraid-os/manual/shares/_category_.json(0 hunks)docs/unraid-os/manual/shares/create-a-share.md(0 hunks)docs/unraid-os/manual/shares/delete-a-share.md(0 hunks)docs/unraid-os/manual/shares/disk-shares.md(0 hunks)docs/unraid-os/manual/shares/network-access.md(0 hunks)docs/unraid-os/manual/shares/shares.md(0 hunks)docs/unraid-os/manual/shares/user-shares.md(0 hunks)docs/unraid-os/manual/tools.md(0 hunks)docs/unraid-os/manual/upgrade-instructions.md(0 hunks)docs/unraid-os/manual/users/_category_.json(0 hunks)docs/unraid-os/manual/users/create-user.md(0 hunks)docs/unraid-os/manual/users/manage-user.md(0 hunks)docs/unraid-os/manual/users/reset-password.md(0 hunks)docs/unraid-os/manual/users/users.md(0 hunks)docs/unraid-os/manual/vm/_category_.json(0 hunks)docs/unraid-os/manual/vm/vm-management.md(0 hunks)docs/unraid-os/manual/vm/vm-support.md(0 hunks)docs/unraid-os/manual/zfs/_category_.json(0 hunks)docs/unraid-os/manual/zfs/placeholder.md(0 hunks)docs/unraid-os/overview/_category_.json(0 hunks)docs/unraid-os/overview/application-server.md(0 hunks)docs/unraid-os/overview/nas.md(0 hunks)docs/unraid-os/overview/ui-reference.md(0 hunks)docs/unraid-os/overview/unraid-management.md(0 hunks)docs/unraid-os/overview/virtualization-host.md(0 hunks)
⛔ Files not processed due to max files limit (35)
- docs/unraid-os/overview/what-is-unraid.md
- docs/unraid-os/release-notes/7.0.0.md
- docs/unraid-os/release-notes/7.0.1.md
- docs/unraid-os/release-notes/7.1.0.md
- docs/unraid-os/system-administration/category.json
- docs/unraid-os/system-administration/monitor-performance/category.json
- docs/unraid-os/system-administration/monitor-performance/smart-reports-and-disk-health.md
- docs/unraid-os/system-administration/secure-your-server/category.json
- docs/unraid-os/system-administration/secure-your-server/secure-remote-access.md
- docs/unraid-os/system-administration/secure-your-server/secure-your-flash-drive.md
- docs/unraid-os/system-administration/secure-your-server/securing-your-connection.md
- docs/unraid-os/system-administration/secure-your-server/securing-your-data.md
- docs/unraid-os/system-administration/secure-your-server/security-fundamentals.md
- docs/unraid-os/system-administration/secure-your-server/user-management.md
- docs/unraid-os/troubleshooting/category.json
- docs/unraid-os/troubleshooting/boot-issues.md
- docs/unraid-os/troubleshooting/cache-issues.md
- docs/unraid-os/troubleshooting/crc-errors.md
- docs/unraid-os/troubleshooting/data-recovery.md
- docs/unraid-os/troubleshooting/diagnostics-information.md
- docs/unraid-os/troubleshooting/docker.md
- docs/unraid-os/troubleshooting/system-crash.md
- docs/unraid-os/troubleshooting/troubleshooting.md
- docs/unraid-os/troubleshooting/unclean-shutdowns.md
- docs/unraid-os/troubleshooting/windows-connection.md
- docs/unraid-os/using-unraid-to/category.json
- docs/unraid-os/using-unraid-to/create-virtual-machines/category.json
- docs/unraid-os/using-unraid-to/create-virtual-machines/other-vm-operating-systems.md
- docs/unraid-os/using-unraid-to/create-virtual-machines/overview-and-system-prep.md
- docs/unraid-os/using-unraid-to/create-virtual-machines/vm-setup.md
- docs/unraid-os/using-unraid-to/customize-your-experience/category.json
- docs/unraid-os/using-unraid-to/customize-your-experience/plugins.md
- docs/unraid-os/using-unraid-to/manage-storage/category.json
- docs/unraid-os/using-unraid-to/manage-storage/array-configuration.md
- docs/unraid-os/using-unraid-to/manage-storage/cache-pools.md
💤 Files with no reviewable changes (90)
- docs/API/upcoming-features.md
- docs/API/category.json
- docs/unraid-os/manual/security/category.json
- docs/unraid-os/faq/category.json
- docs/account/category.json
- docs/legacy/category.json
- docs/unraid-os/guides/category.json
- docs/unraid-os/manual/vm/category.json
- docs/unraid-os/manual/zfs/category.json
- docs/connect/index.md
- docs/unraid-os/manual/users/category.json
- docs/account/account.md
- docs/unraid-os/manual/category.json
- docs/connect/category.json
- docs/unraid-os/manual/users/create-user.md
- docs/unraid-os/manual/shares/create-a-share.md
- docs/unraid-os/manual/shares/category.json
- docs/API/index.md
- docs/unraid-os/overview/unraid-management.md
- docs/unraid-os/manual/security/security.md
- docs/account/link-key.md
- docs/unraid-os/overview/category.json
- docs/unraid-os/manual/vm/vm-management.md
- docs/unraid-os/manual/shares/shares.md
- docs/legacy/FAQ/check-harddrive-speed.md
- docs/unraid-os/getting-started/considerations.md
- docs/connect/privacy.md
- docs/unraid-os/manual/security/flash-drive.md
- docs/legacy/FAQ/transferring-files-from-a-network-share-to-unraid.md
- docs/unraid-os/faq/installation.md
- docs/unraid-os/manual/shares/delete-a-share.md
- docs/unraid-os/manual/users/manage-user.md
- docs/API/how-to-use-the-api.md
- docs/unraid-os/getting-started/manual-install-method.md
- docs/legacy/Articles/expanding-windows-vm-vdisk-partitions.md
- docs/unraid-os/manual/users/users.md
- docs/unraid-os/faq/redeem-license-activation-code.md
- docs/unraid-os/overview/application-server.md
- docs/unraid-os/manual/tools.md
- docs/connect/flash-backup.md
- docs/unraid-os/overview/ui-reference.md
- docs/legacy/FAQ/terminal-access.md
- docs/unraid-os/manual/security/outgoing-proxy-manager.md
- docs/unraid-os/guides/configuring-time-machine.md
- docs/unraid-os/getting-started/getting-started.md
- docs/legacy/FAQ/setting-up-cpu-and-board-temperature-sensing.md
- docs/unraid-os/manual/upgrade-instructions.md
- docs/API/cli.md
- docs/unraid-os/manual/security/data-encryption.md
- docs/legacy/FAQ/setup-sleep-and-wake-on-lan.md
- docs/unraid-os/manual/shares/disk-shares.md
- docs/connect/help.md
- docs/unraid-os/guides/wol-setup-for-unraid.md
- docs/unraid-os/getting-started/advanced-bios-config.md
- docs/unraid-os/manual/users/reset-password.md
- docs/unraid-os/manual/multi-language.md
- docs/legacy/Articles/upgrading-to-unraid-6.md
- docs/connect/remote-access.md
- docs/unraid-os/guides/convert-windows-to-vm.md
- docs/legacy/FAQ/replacing-multiple-data-drives.md
- docs/legacy/FAQ/Parity.md
- docs/legacy/FAQ/transferring-files-within-the-unraid-server.md
- docs/unraid-os/manual/security/vpn.md
- docs/unraid-os/faq/licensing-faq.md
- docs/legacy/FAQ/replacing-a-data-drive.md
- docs/legacy/FAQ/cache-disk.md
- docs/unraid-os/manual/docker-management.md
- docs/unraid-os/manual/zfs/placeholder.md
- docs/unraid-os/overview/virtualization-host.md
- docs/legacy/FAQ/understanding-smart-reports.md
- docs/unraid-os/guides/xen-to-kvm.md
- docs/legacy/FAQ/usb-flash-drive-preparation.md
- docs/unraid-os/manual/changing-the-flash-device.md
- docs/unraid-os/manual/security/tailscale.md
- docs/unraid-os/faq/os-faq.md
- docs/unraid-os/manual/security/secure-webgui-ssl.md
- docs/unraid-os/manual/shares/network-access.md
- docs/unraid-os/getting-started/quick-install-guide.md
- docs/unraid-os/manual/additional-settings.md
- docs/unraid-os/manual/vm/vm-support.md
- docs/unraid-os/guides/physical-to-virtual.md
- docs/unraid-os/manual/security/good-practices.md
- docs/legacy/FAQ/console.md
- docs/legacy/FAQ/parity-swap-procedure.md
- docs/legacy/FAQ/shrink-array.md
- docs/unraid-os/overview/nas.md
- docs/legacy/Articles/dual-boot-unraid-and-windows.md
- docs/unraid-os/manual/shares/user-shares.md
- docs/legacy/FAQ/check-disk-filesystems.md
- docs/unraid-os/manual/applications.md
✅ Files skipped from review due to trivial changes (1)
- docs/unraid-os/getting-started/explore-the-user-interface/tour-the-web-gui.md
🚧 Files skipped from review as they are similar to previous changes (7)
- docs/glossary.md
- docs/unraid-os/advanced-configurations/optimize-storage/category.json
- docs/unraid-os/getting-started/set-up-unraid/category.json
- docs/unraid-os/advanced-configurations/category.json
- docs/unraid-os/getting-started/explore-the-user-interface/category.json
- docs/unraid-os/getting-started/category.json
- docs/unraid-os/getting-started/set-up-unraid/configure-your-array.md
🧰 Additional context used
🪛 LanguageTool
docs/unraid-os/getting-started/set-up-unraid/customize-unraid-settings.md
[style] ~13-~13: For a more polite and respectful tone, consider rephrasing with ‘please’.
Context: ...s](/img/toolbar_settings.png) Don't forget - the WebGUI includes built-in help. To...
(DONT_FORGET)
[uncategorized] ~25-~25: Possible missing article found.
Context: ...ontainer and is no longer accessible to Unraid OS. - You can pin cores without needing...
(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~150-~150: Possible missing comma found.
Context: ...es your system log, which is useful for troubleshooting since Unraid clears the log after each ...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/docs-home.md
[style] ~15-~15: Consider using a different adjective to strengthen your wording.
Context: ...t functionality will look like. Have a great day!
(HAVE_A_NICE_DAY)
docs/unraid-os/advanced-configurations/optimize-storage/zfs-storage.md
[uncategorized] ~44-~44: Possible missing comma found.
Context: ...specific backup or replication scenarios but is not a replacement for a full ZFS poo...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~89-~89: To elevate your writing, try using an alternative expression here.
Context: ...5. Assign disks to the pool (disk order does not matter). <div style={{ margin: 'auto', maxWid...
(MATTERS_RELEVANT)
[uncategorized] ~314-~314: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...aution Most Unraid users should avoid support vdevs/subpools unless you have a specif...
(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
[uncategorized] ~321-~321: The preposition ‘to’ seems more likely in this position.
Context: ...our original pool, including those used for support vdevs, to the pool slots. Unrai...
(AI_HYDRA_LEO_REPLACE_FOR_TO)
[style] ~374-~374: This phrasing can be wordy. For improved clarity, try opting for something more concise.
Context: ...ture isn't yet available in the WebGUI. For the time being, expand via the CLI or add new vdevs th...
(FOR_THE_TIME_BEING)
docs/unraid-os/getting-started/explore-the-user-interface/key-features.md
[uncategorized] ~8-~8: Possible missing comma found.
Context: ...face provides basic controls for common tasks while also offering advanced tuning opt...
(AI_HYDRA_LEO_MISSING_COMMA)
[misspelling] ~16-~16: This expression is normally spelled as one or with a hyphen.
Context: ...le NIC bonding and bridging, set time servers, and configure additional network setti...
(EN_COMPOUNDS_TIME_SERVERS)
docs/unraid-os/getting-started/set-up-unraid/complete-your-post-setup-essentials.md
[grammar] ~27-~27: The usual preposition to use with “corner” is “in”, not “on”. Did you mean “in the top-right corner”?
Context: ...he icon at the top-right corner. You can also toggle help on individual...
(ON_IN_THE_CORNER_2)
[uncategorized] ~35-~35: Possible missing preposition found.
Context: ...](/img/toolbar.png) ## Review security best practices Since your Unraid serve...
(AI_HYDRA_LEO_MISSING_OF)
docs/unraid-os/getting-started/set-up-unraid/create-your-bootable-media.md
[grammar] ~16-~16: The word ‘install’ is not a noun.
Context: ...o format as FAT32. ::: ## Automated install method The automated installation meth...
(A_INSTALL)
[uncategorized] ~31-~31: Possible missing preposition found.
Context: ...gure your server's BIOS settings** - Set the boot device to the USB flash drive....
(AI_HYDRA_LEO_MISSING_TO)
[grammar] ~36-~36: The word ‘install’ is not a noun.
Context: ...to boot into Unraid OS. ## Manual install method The manual installation method ...
(A_INSTALL)
docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.md
[uncategorized] ~42-~42: The preposition “on” seems more likely in this position than the preposition “in”.
Context: ...rd/). You can also update your password in the Users page of the WebGUI. ::: ## R...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_ON)
[typographical] ~93-~93: Do not use a colon (:) before a series that is introduced by a preposition (‘to’). Remove the colon or add a noun or a noun phrase after the preposition.
Context: ...boot, try: ✅ Adjusting the boot order to: Forced-FDD, USB-HDD, *USB-ZIP...
(RP_COLON)
docs/unraid-os/getting-started/unraid-net.md
[uncategorized] ~8-~8: A comma might be missing here.
Context: ...ons, having an account provides several benefits such as streamlined license management,...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~10-~10: You might be missing the article “the” here.
Context: ...se builds, and enhanced support. #### Benefits of an Unraid.net account include: - *...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[misspelling] ~16-~16: This word is normally spelled as one.
Context: ...:** Enjoy secure login with options for multi-factor authentication (MFA). ### Your Accoun...
(EN_COMPOUNDS_MULTI_FACTOR)
[misspelling] ~20-~20: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...he Data that's Stored Unraid.net uses a SSO system at account.unraid.net for se...
(EN_A_VS_AN)
[misspelling] ~30-~30: This word is normally spelled as one.
Context: ...etails | Information for multi-factor authentication | | Google...
(EN_COMPOUNDS_MULTI_FACTOR)
docs/unraid-os/getting-started/what-is-unraid.md
[style] ~21-~21: Consider using a more concise synonym.
Context: ...hed Storage (NAS) device. It can handle a variety of drives, whether they connect through ID...
(A_VARIETY_OF)
[style] ~64-~64: To strengthen your wording, consider replacing the phrasal verb “leave out”.
Context: ...so customize these shares to include or leave out certain drives and decide how files are...
(OMIT_EXCLUDE)
[style] ~84-~84: Opting for a less wordy alternative here may improve the clarity of your writing.
Context: ...e pool with multiple drives. This setup not only increases storage space but also uses technologies like ZFS or BTRFS to provi...
(NOT_ONLY_ALSO)
[uncategorized] ~111-~111: Do not mix variants of the same word (‘pre-configure’ and ‘preconfigure’) within a single text.
Context: ...ker by providing access to thousands of pre-configured apps through Docker Hub and C...
(EN_WORD_COHERENCY)
🪛 markdownlint-cli2 (0.17.2)
docs/unraid-os/advanced-configurations/optimize-storage/zfs-storage.md
39-39: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
57-57: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
72-72: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
85-85: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
93-93: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
102-102: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
114-114: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
120-120: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
154-154: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
162-162: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
177-177: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
204-204: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
232-232: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
249-249: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
287-287: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
301-301: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
docs/unraid-os/getting-started/set-up-unraid/create-your-bootable-media.md
40-40: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
40-40: Headings must start at the beginning of the line
null
(MD023, heading-start-left)
40-40: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
46-46: Headings must start at the beginning of the line
null
(MD023, heading-start-left)
46-46: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
56-56: Headings must start at the beginning of the line
null
(MD023, heading-start-left)
56-56: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
60-60: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
62-62: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
64-64: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
65-65: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
66-66: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
67-67: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
68-68: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
docs/unraid-os/getting-started/unraid-net.md
10-10: Heading levels should only increment by one level at a time
Expected: h2; Actual: h4
(MD001, heading-increment)
10-10: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
docs/unraid-os/getting-started/what-is-unraid.md
19-19: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
137-137: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
139-139: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
141-141: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
143-143: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
145-145: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
147-147: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
149-149: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
151-151: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
🔇 Additional comments (30)
docs/docs-home.md (3)
6-6: Import Term component correctly importedThe
Termcomponent import path is valid and ready for use.
9-9: Page title is set correctlyThe top-level heading
# Homefollows documentation conventions.
11-11: Section header is clearThe
## Unraid Documentationheading accurately describes this content block.docs/unraid-os/getting-started/unraid-net.md (3)
1-4: Frontmatter is configured appropriatelyThe sidebar position and label align with project conventions.
6-6: Heading structure is correctThe
# Unraid.nettitle clearly identifies this section.
8-8: Introduction content is clearThe overview of Unraid.net account benefits is concise and accurate.
docs/unraid-os/getting-started/explore-the-user-interface/key-features.md (3)
1-4: Frontmatter setup is valid
sidebar_positionandsidebar_labelare correctly defined.
6-6: Main heading is appropriate
# Key Featuresprovides a clear entry point.
8-8: Introduction paragraph reads wellThe description of the WebGUI’s dual design focus is concise and informative.
docs/unraid-os/advanced-configurations/optimize-storage/zfs-storage.md (5)
1-4: Frontmatter configuration is correct
sidebar_positionandsidebar_labelfollow naming conventions.
9-9: Header is clear and descriptiveThe
# ZFS storagetitle accurately reflects the guide’s focus.
11-13: Acknowledgments section formatted correctlyThe
:::importantadmonition block is properly structured to highlight special thanks.
15-15: Introduction paragraph is informativeThe overview of ZFS benefits and guide scope is well-written.
17-17: Section separator is appropriateThe horizontal rule clearly divides content sections.
docs/unraid-os/getting-started/set-up-unraid/complete-your-post-setup-essentials.md (16)
1-4: Frontmatter is correctly defined
sidebar_positionandsidebar_labelalign with project standards.
6-6: Main heading is appropriateThe
# Complete your post-setup essentialstitle clearly introduces the section.
8-8: Opening line is welcoming“Congratulations on your initial setup!” provides a positive tone.
10-10: Transition sentence is clearThis sentence effectively guides the reader to the next steps.
12-12: Secondary heading is clearThe
## Back up your flash deviceheader accurately describes the content.
14-16: Backup instructions are clearThe steps for backing up the flash device are concise and actionable.
18-20: Warning admonition is correctly formattedThe
:::warningblock appropriately highlights a critical note.
21-23: Note admonition is correctly formattedThe
:::noteblock clearly presents an alternative backup method.
25-25: Usage heading is clearThe
## Use the built-in helpheader accurately labels this section.
29-33: Image wrapper markup is correctThe
<div>block and image display follow project guidelines.
35-35: Review heading is clearThe
## Review security best practicesheading clearly signals this section.
37-37: Security guidance is well-presentedThe advice to review best practices is concise and appropriate.
39-39: Plugin heading is clearThe
## Unraid Connectheader accurately introduces the plugin section.
41-41: Plugin description is informativeThis paragraph succinctly describes Unraid Connect and its use.
43-43: Dashboard image inclusion is correctThe dashboard screenshot is properly linked and captioned.
45-45: Privacy reference is clearThe reference to the privacy section provides useful context.
| <div style={{ margin: 'auto', maxWidth: '700px'}}> | ||
|
|
||
|  | ||
| </div> |
There was a problem hiding this comment.
Relocate images into an assets/ folder
All image references (/img/...) should use a local assets/ subfolder adjacent to this markdown file per the project checklist.
- 
+ Repeat for each image reference.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <div style={{ margin: 'auto', maxWidth: '700px'}}> | |
|  | |
| </div> | |
| <div style={{ margin: 'auto', maxWidth: '700px'}}> | |
|  | |
| </div> |
🤖 Prompt for AI Agents
In docs/unraid-os/getting-started/set-up-unraid/customize-unraid-settings.md
around lines 9 to 12, the image reference uses the path
/img/toolbar_settings.png which should be changed to use a local assets/
subfolder adjacent to this markdown file. Update the image path to
./assets/toolbar_settings.png and apply the same change to all other image
references in this file to comply with the project checklist.
| :::note | ||
|
|
||
| For advanced Docker settings, check out <u>Using Unraid to > Run Docker Containers</u>. | ||
|
|
||
| ::: | ||
|
|
There was a problem hiding this comment.
Fix broken link markup for Docker guide
The <u> tag containing “Using Unraid to > Run Docker Containers” is invalid and missing a proper link.
- For advanced Docker settings, check out <u>Using Unraid to > Run Docker Containers</u>.
+ For advanced Docker settings, check out [Using Unraid to Run Docker Containers](../../manual/docker-management/).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| :::note | |
| For advanced Docker settings, check out <u>Using Unraid to > Run Docker Containers</u>. | |
| ::: | |
| :::note | |
| For advanced Docker settings, check out [Using Unraid to Run Docker Containers](../../manual/docker-management/). | |
| ::: |
🤖 Prompt for AI Agents
In docs/unraid-os/getting-started/what-is-unraid.md around lines 113 to 118, the
note uses an invalid <u> tag for the text "Using Unraid to > Run Docker
Containers" and lacks a proper hyperlink. Replace the <u> tag with a Markdown
link syntax, providing the correct URL or relative path to the Docker guide, so
the text becomes a clickable link with proper formatting.
|
|
||
| For VM setup steps, check out <u>Using Unraid to > Create virtual machines</u> | ||
|
|
||
| :::caution |
There was a problem hiding this comment.
Fix broken link markup for VM setup
The <u> tag “Using Unraid to > Create virtual machines” is invalid and missing a proper link.
- For VM setup steps, check out <u>Using Unraid to > Create virtual machines</u>
+ For VM setup steps, check out [Create virtual machines](../../manual/vm-management/).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| For VM setup steps, check out <u>Using Unraid to > Create virtual machines</u> | |
| :::caution | |
| For VM setup steps, check out [Create virtual machines](../../manual/vm-management/) | |
| :::caution |
🤖 Prompt for AI Agents
In docs/unraid-os/getting-started/what-is-unraid.md around lines 187 to 190, the
VM setup reference uses an invalid <u> tag and lacks a proper hyperlink. Replace
the <u> tag with correct markdown link syntax, providing the appropriate URL or
relative path to the "Using Unraid to Create virtual machines" page, ensuring
the link text is clear and clickable.
|
Build is failing due to this: |
The destination links need to be updated for the new structure
|
This pull request is automatically being deployed by Amplify Hosting (learn more). |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
docs/unraid-os/release-notes/6.10.0.md (3)
134-134: Refine sentence for clarity and style
Consider adding commas for readability:-More information including use cases may be found in Documentation [here](../system-administration/secure-your-server/securing-your-connection.md). +More information, including use cases, may be found in the documentation [here](../system-administration/secure-your-server/securing-your-connection.md).
145-145: Use descriptive link text instead of "here"
Replace the non-descriptive "here are instructions" with more meaningful text:-Also, [here are instructions](../using-unraid-to/create-virtual-machines/other-vm-operating-systems.md#upgrading-to-windows-11) +Also, see [instructions for upgrading a Windows 10 VM to Windows 11](../using-unraid-to/create-virtual-machines/other-vm-operating-systems.md#upgrading-to-windows-11).
345-345: Scope link to full phrase for clarity
Extend the link to cover "User Share file system" for better context:-- Fixed issue in [User Share](../using-unraid-to/manage-storage/shares.md#user-shares) file system where permissions were not being honored. +- Fixed issue in [User Share file system](../using-unraid-to/manage-storage/shares.md#user-shares) where permissions were not being honored.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
static/img/configuringarray1.pngis excluded by!**/*.png
📒 Files selected for processing (1)
docs/unraid-os/release-notes/6.10.0.md(3 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/unraid-os/release-notes/6.10.0.md
[typographical] ~134-~134: Consider adding two commas here.
Context: ...s://[lan-ip].[hash].myunraid.net` More information including use cases may be found in Documentation [here](.....
(UNLIKE_COMMA)
[style] ~345-~345: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...to a pool name that contains a space. - Fixed issue in [User Share](../using-unraid-t...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: build
- GitHub Check: AWS Amplify Console Web Preview
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (1)
docs/unraid-os/getting-started/set-up-unraid/create-your-bootable-media.md (1)
8-8: Use fragment-only intra-page links for navigation
The links currently include the filename; simplify to fragment identifiers (e.g.,#automated-installation-method) for cleaner, maintainable intra-page navigation.Proposed diff:
- You can create this bootable media using our recommended [Automated install method](./create-your-bootable-media.md#automated-install-method) with our **USB Flash Creator** tool or by following the [Manual installation method](./create-your-bootable-media.md#manual-install-method). In both cases, you will need a high-quality USB flash drive (between 4 and 32 GB) that has a unique GUID. + You can create this bootable media using our recommended [Automated installation method](#automated-installation-method) with our **USB Flash Creator** tool or by following the [Manual installation method](#manual-installation-method). In both cases, you will need a high-quality USB flash drive (between 4 and 32 GB) that has a unique GUID.
🧹 Nitpick comments (1)
docs/unraid-os/getting-started/set-up-unraid/create-your-bootable-media.md (1)
16-16: Consistent noun usage: use “installation” instead of “install”
Use the noun “installation” for method names to follow proper grammar.Proposed diff:
- ## Automated install method + ## Automated installation method - ## Manual install method + ## Manual installation methodAlso applies to: 36-36
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/unraid-os/getting-started/set-up-unraid/create-your-bootable-media.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/unraid-os/getting-started/set-up-unraid/create-your-bootable-media.md
[grammar] ~16-~16: The word ‘install’ is not a noun.
Context: ...o format as FAT32. ::: ## Automated install method The automated installation meth...
(A_INSTALL)
[uncategorized] ~31-~31: Possible missing preposition found.
Context: ...gure your server's BIOS settings** - Set the boot device to the USB flash drive....
(AI_HYDRA_LEO_MISSING_TO)
[grammar] ~36-~36: The word ‘install’ is not a noun.
Context: ...to boot into Unraid OS. ## Manual install method The manual installation method ...
(A_INSTALL)
🪛 markdownlint-cli2 (0.17.2)
docs/unraid-os/getting-started/set-up-unraid/create-your-bootable-media.md
40-40: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
40-40: Headings must start at the beginning of the line
null
(MD023, heading-start-left)
40-40: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
46-46: Headings must start at the beginning of the line
null
(MD023, heading-start-left)
46-46: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
56-56: Headings must start at the beginning of the line
null
(MD023, heading-start-left)
56-56: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
60-60: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
62-62: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
64-64: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
65-65: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
66-66: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
67-67: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
68-68: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: AWS Amplify Console Web Preview
| - **Windows 7 or later:** | ||
| Right-click `make_bootable` and select **Run as administrator**. | ||
| - **Mac:** | ||
| Double-click `make_bootable_mac` and enter your admin password. | ||
| - **Linux:** | ||
| - Copy `make_bootable_linux` to your hard drive. | ||
| - Unmount the USB drive. | ||
| - In the terminal, run: |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Correct list indentation and specify code fence language
Top-level lists should start at column 0, nested lists at two spaces, and fenced code blocks must declare a language for proper linting.
Proposed diff:
- - **Windows 7 or later:**
- Right-click `make_bootable` and select **Run as administrator**.
- - **Mac:**
- Double-click `make_bootable_mac` and enter your admin password.
- - **Linux:**
- - Copy `make_bootable_linux` to your hard drive.
- - Unmount the USB drive.
- - In the terminal, run:
- ```
- sudo bash ./make_bootable_linux
- ```
+ - **Windows 7 or later**
+ Right-click `make_bootable` and select **Run as administrator**.
+ - **Mac**
+ Double-click `make_bootable_mac` and enter your admin password.
+ - **Linux**
+ - Copy `make_bootable_linux` to your hard drive.
+ - Unmount the USB drive.
+ - In the terminal, run:
+ ```shell
+ sudo bash ./make_bootable_linux
+ ```Also applies to: 68-70
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
60-60: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
62-62: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
64-64: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
65-65: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
66-66: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
67-67: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
🤖 Prompt for AI Agents
In docs/unraid-os/getting-started/set-up-unraid/create-your-bootable-media.md
around lines 60 to 70, the list indentation is incorrect and the fenced code
block lacks a language specifier. Fix the top-level list items to start at
column 0 with no leading spaces, indent nested list items by two spaces, and add
the language identifier "shell" to the fenced code block for proper syntax
highlighting and linting.
|
|
||
| The manual installation method is designed for situations where the USB Flash Creator tool is either unavailable or incompatible with your hardware. This approach provides complete control over the formatting and setup process, making it ideal for advanced users or for troubleshooting specific issues with a USB device. | ||
|
|
||
| #### Prepare your USB device: |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Fix heading levels and remove trailing punctuation
Markdown lint requires sequential heading increments (no jumping from h2 to h4), no leading spaces, and no trailing punctuation in headings.
Proposed diff:
- #### Prepare your USB device:
+ ### Prepare your USB device
- #### Download and extract:
+ ### Download and extract
- #### Make the USB device bootable:
+ ### Make the USB device bootableAlso applies to: 46-46, 56-56
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
40-40: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
40-40: Headings must start at the beginning of the line
null
(MD023, heading-start-left)
40-40: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
🤖 Prompt for AI Agents
In docs/unraid-os/getting-started/set-up-unraid/create-your-bootable-media.md at
lines 40, 46, and 56, fix the heading levels to ensure they increment
sequentially without skipping levels, remove any leading spaces before the
heading markers, and eliminate trailing punctuation marks from the headings.
Adjust the markdown headings accordingly to comply with markdown lint rules.
There was a problem hiding this comment.
Actionable comments posted: 6
♻️ Duplicate comments (1)
docs/unraid-os/advanced-configurations/optimize-storage/zfs-storage.md (1)
37-42: Images still violate docs-style guidelines — must add alt text & relocate toassets/Every
reference:• omits descriptive alt text (markdown-lint MD045)
• uses the root-level/img/path that broke the build earlier (static/img/configuringarray1.png), instead of anassets/folder adjacent to this article.This exact feedback was given in the previous review and remains unresolved.
Proposed fix (example applies to the first image; replicate for all others and move the PNGs):
- +After updating the links, move the images to:
docs/unraid-os/advanced-configurations/optimize-storage/assets/and ensure the filenames match case-sensitively.
Failing to address this will continue to break the docs build.
Also applies to: 55-60, 70-76, 83-88, 91-96, 100-106, 112-118, 118-124, 152-158, 160-166, 175-181, 200-206, 230-236, 286-292, 298-304
🧹 Nitpick comments (27)
docs/unraid-os/system-administration/maintain-and-update/upgrading-unraid.md (2)
86-89: Convert bare URL to a proper Markdown linkThe raw URL in step 2 violates MD034 and breaks visual consistency with the rest of the page.
-2. Paste this URL into the field: https://stable.dl.unraid.net/unRAIDServer.plg +2. Paste this URL into the field: <https://stable.dl.unraid.net/unRAIDServer.plg>
161-165: Missing comma after introductory clauseA quick readability fix:
-Manual upgrades are infrequently necessary but may be needed if you can’t access the WebGUI or need to revert to a prior version. +Manual upgrades are infrequently necessary, but may be needed if you can’t access the WebGUI or need to revert to a prior version.docs/unraid-os/troubleshooting/troubleshooting.md (1)
5-7: Hyphenate “top-right” for clarity- icon in the top right corner + icon in the top-right cornerdocs/unraid-os/troubleshooting/common-issues/system-crashes-and-stability.md (1)
112-121: Add blank lines before and after the tableMD058 requires blank lines to avoid parsing issues.
-<div style={{ margin: 'auto', maxWidth: '600px', display: 'flex', flexDirection: 'column', alignItems: 'center' }}> - | Tool Type | Recommendations | @@ | **Alert Systems** | Set thresholds for: | | | - CPU >80°C sustained | | | - RAM usage >90% for 5+ min | -</div> + +``` +(Optional wrapper div is unnecessary; consider removing if not required for styling.)docs/unraid-os/troubleshooting/common-issues/docker-troubleshooting.md (1)
65-77: Specify fenced-block language for proper syntax-highlighting
markdownlint(MD040) flags these blocks because the language is missing.
Addingshell(orbash) improves readability and disables the warning.-``` -docker network ls -``` +```shell +docker network ls +``` … -``` -docker network create <network-name> -``` +```shell +docker network create <network-name> +```docs/unraid-os/troubleshooting/faq.md (2)
219-238: Add language identifiers to code fencesSeveral code blocks that show PCI device IDs are missing a language tag, triggering MD040.
Even a generictexttag is sufficient.-``` +[```text … -``` +[```text
147-147: Use the verb back up instead of the noun “Backup”Minor grammatical tweak for clarity:
-1. Backup any data you wish to keep. +1. Back up any data you wish to keep.docs/unraid-os/troubleshooting/diagnostics/udma-crc-errors.md (1)
17-17: Hyphenate “ultra-direct-memory-access”The compound adjective should be hyphenated to match standard usage.
-in the context of UDMA (ultra direct memory access), +in the context of UDMA (ultra-direct-memory-access),docs/unraid-os/system-administration/secure-your-server/securing-your-data.md (1)
17-20: Reduce repetitive sentence openingsThree successive bullets start with “You …”.
Consider re-phrasing for flow, e.g.:-- You store confidential, regulated, or sensitive data on your Unraid server. -- You are concerned about data theft if a drive is physically removed or stolen. -- You need to comply with organizational or legal data protection requirements. +- Store confidential, regulated, or sensitive data on the server. +- Worry about theft of drives and subsequent data exposure. +- Must comply with organisational or legal data-protection mandates.docs/unraid-os/system-administration/secure-your-server/secure-your-outgoing-comms.md (1)
16-24: Heading level jumps: change H3 to H2
### Outgoing proxy vs. VPNfollows an H1 without an intervening H2, violating MD001.-### Outgoing proxy vs. VPN: Which should you use? +## Outgoing proxy vs. VPN: Which should you use?docs/unraid-os/troubleshooting/diagnostics/capture-diagnostics-and-logs.md (1)
155-157: Add a language tag to silence MD040Markdown-lint complains because the fence lacks a language.
-``` -/path/in/container:/logs -``` +```text +/path/in/container:/logs +```docs/unraid-os/using-unraid-to/create-virtual-machines/overview-and-system-prep.md (1)
141-146: Indentation inside admonition breaks MD007 & renders oddlyThe unordered list inside
:::tip General tipsis indented by two spaces, causing markdown-lint warnings and extra<p>tags.- - Use OVMF (UEFI) for VMs with modern GPUs. - - Always use the latest Unraid version for improved hardware support. - - Technologies like NVIDIA Optimus may allow GPU passthrough for laptops or advanced setups, but results vary. +- 10000 Use OVMF (UEFI) for VMs with modern GPUs. +- Always use the latest Unraid version for improved hardware support. +- Technologies like NVIDIA Optimus may allow GPU passthrough for laptops or advanced setups, but results vary.docs/unraid-os/system-administration/secure-your-server/securing-your-connection.md (1)
161-174: Clarify redirect list formattingThe three redirect cases are rendered as a bullet list with nested admonitions, but without blank lines markdown collapses them.
Add blank lines before and after the list and each admonition for cleaner output; this also satisfies MD058.
docs/unraid-os/system-administration/secure-your-server/tailscale.md (3)
20-22: Use H-2 headings after the H-1 to comply with MD001
Heading levels jump from#to###, which violates the heading-increment rule and hurts document structure.-### Getting started with Tailscale +## Getting started with TailscaleApply the same demotion to every other
###that represents a top-level section (e.g., “Adding Tailscale to Docker Containers”, “Updating Tailscale”, “Userspace networking”).
134-140: Add a clarifying comma for readability
Missing comma after the introductory adverbial phrase.- update the plugin through the Unraid Apps tab just like any other plugin. + update the plugin through the Unraid Apps tab, just like any other plugin.
139-141: Prefer “upper-right corner” (compound adjective) for consistency
Minor copy-editing to match technical-writing conventions.- (upper right corner), + (upper-right corner),docs/unraid-os/system-administration/secure-your-server/wireguard.md (4)
23-27: Fix heading-level jump (MD001)
Change### Connection types and use casesto H-2.-### Connection types and use cases +## Connection types and use casesReplicate for any other section directly under the H-1.
35-36: Hyphenate compound modifier “Route-specific”
Grammar / clarity.-| VPN tunneled access | Route specific Docker containers and VMs through a com... +| VPN tunneled access | Route-specific Docker containers and VMs through a com...
176-179: Insert determiner “the” before “client configuration file”
Fluency improvement.- - Save changes and update client configuration file. + - Save changes and update the client configuration file.
49-52: Replace emphasis-as-heading with real heading
Using**Step 1: Generate keys**triggers MD036. Convert to a proper heading.-**Step 1: Generate keys** +### Step 1: Generate keysRepeat for the other “Step N” sections.
docs/unraid-os/troubleshooting/common-issues/data-recovery.md (2)
65-74: Specify language on fenced code blocks (MD040)
Missing language identifier; causes syntax-highlighting and lint failures.- ```bash + ```bash xfs_repair -v /dev/[disk] ```Apply to every fenced block (lines 74-81, 130-133, 139-146, 156-165, 180-189, 210-217).
200-202: Past tense preferred: “may be corrupted”
Minor tense adjustment for correctness.- some files may be corrupt, especially if the disk had many unreadable sectors. + some files may be corrupted, especially if the disk had many unreadable sectors.docs/unraid-os/system-administration/secure-your-server/security-fundamentals.md (2)
30-33: Insert comma after introductory phrase
Improves readability.- macOS systems. NFS and FTP are turned off but can be enabled if needed. For instance, + macOS systems. NFS and FTP are turned off but can be enabled if needed. For instance,
128-131: Missing determiner “the” before “permissions”
Micro-copy fix.- Assign user accounts with only the permissions needed for their role (least privilege). + Assign user accounts with only the permissions needed for their role (the least privilege).docs/unraid-os/using-unraid-to/create-virtual-machines/unraid-as-a-vm.md (3)
46-53: Add language identifier to syslinux.cfg snippet (MD040)- ``` + ```ini label Unraid OS
56-58: Add language identifier tostartup.nshsnippet- ``` + ```plain \EFI\boot\bootx64.efi
129-131: Heading level jump: change### Troubleshootingto H-2-### Troubleshooting +## Troubleshooting
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (3)
docs/unraid-os/using-unraid-to/customize-your-experience/image.pngis excluded by!**/*.pngstatic/img/Diagnostics.jpgis excluded by!**/*.jpgstatic/img/Switch_toggle_icon.pngis excluded by!**/*.png
📒 Files selected for processing (26)
docs/unraid-os/advanced-configurations/optimize-storage/zfs-storage.md(1 hunks)docs/unraid-os/system-administration/advanced-tools/_category_.json(1 hunks)docs/unraid-os/system-administration/advanced-tools/wake-on-lan.md(1 hunks)docs/unraid-os/system-administration/maintain-and-update/_category_.json(1 hunks)docs/unraid-os/system-administration/maintain-and-update/changing-the-flash-device.md(1 hunks)docs/unraid-os/system-administration/maintain-and-update/upgrading-unraid.md(1 hunks)docs/unraid-os/system-administration/secure-your-server/secure-your-outgoing-comms.md(1 hunks)docs/unraid-os/system-administration/secure-your-server/securing-your-connection.md(1 hunks)docs/unraid-os/system-administration/secure-your-server/securing-your-data.md(1 hunks)docs/unraid-os/system-administration/secure-your-server/security-fundamentals.md(1 hunks)docs/unraid-os/system-administration/secure-your-server/tailscale.md(1 hunks)docs/unraid-os/system-administration/secure-your-server/wireguard.md(1 hunks)docs/unraid-os/troubleshooting/_category_.json(1 hunks)docs/unraid-os/troubleshooting/common-issues/_category_.json(1 hunks)docs/unraid-os/troubleshooting/common-issues/boot-and-startup-failures.md(1 hunks)docs/unraid-os/troubleshooting/common-issues/data-recovery.md(1 hunks)docs/unraid-os/troubleshooting/common-issues/docker-troubleshooting.md(1 hunks)docs/unraid-os/troubleshooting/common-issues/system-crashes-and-stability.md(1 hunks)docs/unraid-os/troubleshooting/common-issues/unclean-shutdowns.md(1 hunks)docs/unraid-os/troubleshooting/diagnostics/_category_.json(1 hunks)docs/unraid-os/troubleshooting/diagnostics/capture-diagnostics-and-logs.md(1 hunks)docs/unraid-os/troubleshooting/diagnostics/udma-crc-errors.md(1 hunks)docs/unraid-os/troubleshooting/faq.md(1 hunks)docs/unraid-os/troubleshooting/troubleshooting.md(1 hunks)docs/unraid-os/using-unraid-to/create-virtual-machines/overview-and-system-prep.md(1 hunks)docs/unraid-os/using-unraid-to/create-virtual-machines/unraid-as-a-vm.md(1 hunks)
✅ Files skipped from review due to trivial changes (5)
- docs/unraid-os/troubleshooting/diagnostics/category.json
- docs/unraid-os/troubleshooting/category.json
- docs/unraid-os/system-administration/advanced-tools/category.json
- docs/unraid-os/system-administration/maintain-and-update/category.json
- docs/unraid-os/troubleshooting/common-issues/category.json
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: expliyh
PR: unraid/docs#281
File: i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/faq/installation.md:26-26
Timestamp: 2025-05-23T16:04:50.060Z
Learning: The folder name for enabling UEFI boot mode in Unraid documentation is specified as "EFI~" (with a tilde), which is then renamed to "EFI". This is the correct notation as it matches the English version of the documentation.
Learnt from: expliyh
PR: unraid/docs#281
File: i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/faq/installation.md:26-26
Timestamp: 2025-05-23T16:04:50.060Z
Learning: In the Unraid documentation, the folder for enabling UEFI boot mode is named "efi~" (lowercase with a tilde) in the English version, which is renamed to "efi". In the Chinese translation, this is represented as "EFI~" (uppercase with a tilde) renamed to "EFI". The tilde character is the correct notation, not a hyphen.
Learnt from: expliyh
PR: unraid/docs#281
File: i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/getting-started/quick-install-guide.md:0-0
Timestamp: 2025-05-23T16:28:30.374Z
Learning: 在Unraid简体中文界面中，"Main"标签页/按钮被翻译为"主页面"，中文文档应使用"主页面"而非英文"Main"以保持与实际用户界面的一致性。
docs/unraid-os/system-administration/maintain-and-update/upgrading-unraid.md (1)
Learnt from: expliyh
PR: unraid/docs#281
File: i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/getting-started/quick-install-guide.md:0-0
Timestamp: 2025-05-23T16:28:30.374Z
Learning: 在Unraid简体中文界面中，"Main"标签页/按钮被翻译为"主页面"，中文文档应使用"主页面"而非英文"Main"以保持与实际用户界面的一致性。
docs/unraid-os/troubleshooting/common-issues/boot-and-startup-failures.md (2)
Learnt from: expliyh
PR: unraid/docs#281
File: i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/faq/installation.md:26-26
Timestamp: 2025-05-23T16:04:50.060Z
Learning: The folder name for enabling UEFI boot mode in Unraid documentation is specified as "EFI~" (with a tilde), which is then renamed to "EFI". This is the correct notation as it matches the English version of the documentation.
Learnt from: expliyh
PR: unraid/docs#281
File: i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/faq/installation.md:26-26
Timestamp: 2025-05-23T16:04:50.060Z
Learning: In the Unraid documentation, the folder for enabling UEFI boot mode is named "efi~" (lowercase with a tilde) in the English version, which is renamed to "efi". In the Chinese translation, this is represented as "EFI~" (uppercase with a tilde) renamed to "EFI". The tilde character is the correct notation, not a hyphen.
🪛 LanguageTool
docs/unraid-os/troubleshooting/troubleshooting.md
[uncategorized] ~6-~6: Consider adding a hyphen.
Context: ... icon in the top right corner to access help for the entire pa...
(TOP_LEFT_CORNER)
docs/unraid-os/system-administration/maintain-and-update/upgrading-unraid.md
[uncategorized] ~163-~163: Possible missing comma found.
Context: ...nual upgrades are infrequently necessary but may be needed if you can’t access the *...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/unraid-os/troubleshooting/common-issues/system-crashes-and-stability.md
[uncategorized] ~22-~22: Possible missing comma found.
Context: ...ns (v6.0+) support both UEFI and Legacy modes with enhanced DDR4/DDR5 compatibility. ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~85-~85: Possible missing comma found.
Context: ...ocker containers over plugins for added features since containers provide better isolati...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~93-~93: Consider using an alternative to avoid wordiness and strengthen your wording.
Context: ...ument your update process and review it from time to time to ensure you’re following best practic...
(FROM_TIME_TO_TIME)
docs/unraid-os/troubleshooting/common-issues/unclean-shutdowns.md
[grammar] ~60-~60: Possible agreement error. Did you mean “ongoings”?
Context: ...down. However, be cautious if there are ongoing write operations to the array. ::: ...
(THERE_RE_MANY)
[uncategorized] ~155-~155: You might be missing the article “the” here.
Context: ...ete. - If the battery runs out before shutdown completes, you risk an unclean shutdown...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
docs/unraid-os/system-administration/secure-your-server/securing-your-connection.md
[uncategorized] ~23-~23: A determiner appears to be missing. Consider inserting it.
Context: ...| Set in Settings > Identification. Default is tower. ...
(AI_EN_LECTOR_MISSING_DETERMINER)
[uncategorized] ~24-~24: A determiner appears to be missing. Consider inserting it.
Context: ...et in Settings > Management Access. Default is local. ...
(AI_EN_LECTOR_MISSING_DETERMINER)
[uncategorized] ~26-~26: A determiner appears to be missing. Consider inserting it.
Context: ...et in Settings > Management Access. Default is 80. ...
(AI_EN_LECTOR_MISSING_DETERMINER)
[uncategorized] ~27-~27: A determiner appears to be missing. Consider inserting it.
Context: ...et in Settings > Management Access. Default is 443. ...
(AI_EN_LECTOR_MISSING_DETERMINER)
[uncategorized] ~103-~103: This verb does not appear to agree with the subject. Consider using a different form.
Context: .... Your primary URLs when Use SSL/TLS is set to No: - `http://[servername].[...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[uncategorized] ~107-~107: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...) **Your primary URLs when Use SSL/TLS is set to Yes (uses self-signed certific...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
docs/unraid-os/system-administration/secure-your-server/tailscale.md
[uncategorized] ~129-~129: It appears that hyphens are missing in the adjective “up-to-date”.
Context: ...y Docker containers using Tailscale are up to date. To update Tailscale: - **Update the ...
(UP_TO_DATE_HYPHEN)
[uncategorized] ~134-~134: Possible missing comma found.
Context: ...date the plugin through the Unraid Apps tab just like any other plugin. You can alw...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~139-~139: Consider adding a hyphen.
Context: ... - Switching to Advanced View (upper right corner), then clicking Force update...
(TOP_LEFT_CORNER)
docs/unraid-os/using-unraid-to/create-virtual-machines/overview-and-system-prep.md
[uncategorized] ~44-~44: Loose punctuation mark.
Context: ...Holds VM virtual disk images. - isos: Contains installation ISOs and driver i...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~45-~45: Loose punctuation mark.
Context: ...ion ISOs and driver images. - system: Stores libvirt.img and other critical...
(UNLIKELY_OPENING_PUNCTUATION)
[style] ~148-~148: Consider a different adverb to strengthen your wording.
Context: ... setups, but results vary. ::: :::info Always changing Hardware and driver compatibi...
(ALWAYS_CONSTANTLY)
[uncategorized] ~190-~190: Loose punctuation mark.
Context: ...ser shares for virtualization: - isos: This share stores installation media fi...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~191-~191: Loose punctuation mark.
Context: ...on media files for your VMs. - domains: This share holds virtual machine disk i...
(UNLIKELY_OPENING_PUNCTUATION)
docs/unraid-os/system-administration/secure-your-server/wireguard.md
[uncategorized] ~35-~35: When ‘Route-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ... | | VPN tunneled access | Route specific Docker containers and VMs through a com...
(SPECIFIC_HYPHEN)
[uncategorized] ~178-~178: You might be missing the article “the” here.
Context: ...he Peer DNS Server field. - Save changes and update the client configuration fil...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~214-~214: Possible missing comma found.
Context: ... ("Active" means the tunnel has started but is not necessarily connected.) - ✅ DDN...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/unraid-os/system-administration/maintain-and-update/changing-the-flash-device.md
[uncategorized] ~245-~245: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ... commit assignments. Data drives should mount, and their contents should remain intac...
(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
docs/unraid-os/system-administration/secure-your-server/security-fundamentals.md
[uncategorized] ~30-~30: Possible missing comma found.
Context: ...acOS systems. NFS and FTP are turned off but can be enabled if needed. For instance...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~130-~130: A determiner may be missing.
Context: ... the permissions needed for their role (least privilege). - Limit share access to spe...
(THE_SUPERLATIVE)
docs/unraid-os/troubleshooting/common-issues/data-recovery.md
[grammar] ~87-~87: Probably a preposition is missing after ‘attempts’.
Context: ... you’re unsure. ::: If these repair attempts do not resolve the issue or if you encount...
(ATD_VERBS_TO_COLLOCATION)
[uncategorized] ~201-~201: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ... may be corrupt, especially if the disk had many unreadable sectors. Using checksum...
(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
docs/unraid-os/advanced-configurations/optimize-storage/zfs-storage.md
[uncategorized] ~44-~44: Possible missing comma found.
Context: ...specific backup or replication scenarios but is not a replacement for a full ZFS poo...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~89-~89: To elevate your writing, try using an alternative expression here.
Context: ...5. Assign disks to the pool (disk order does not matter). <div style={{ margin: 'auto', maxWid...
(MATTERS_RELEVANT)
[uncategorized] ~314-~314: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...aution Most Unraid users should avoid support vdevs/subpools unless you have a specif...
(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
[uncategorized] ~321-~321: The preposition ‘to’ seems more likely in this position.
Context: ...our original pool, including those used for support vdevs, to the pool slots. Unrai...
(AI_HYDRA_LEO_REPLACE_FOR_TO)
[style] ~374-~374: This phrasing can be wordy. For improved clarity, try opting for something more concise.
Context: ...ture isn't yet available in the WebGUI. For the time being, expand via the CLI or add new vdevs th...
(FOR_THE_TIME_BEING)
docs/unraid-os/system-administration/secure-your-server/securing-your-data.md
[style] ~19-~19: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...rive is physically removed or stolen. - You need to comply with organizational or l...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
docs/unraid-os/troubleshooting/common-issues/boot-and-startup-failures.md
[uncategorized] ~132-~132: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ss. ::: If your Unraid boot drive fails and you don’t have a recent backup or knowl...
(COMMA_COMPOUND_SENTENCE)
docs/unraid-os/troubleshooting/common-issues/docker-troubleshooting.md
[style] ~12-~12: Consider using a more concise synonym.
Context: ...com/). ::: Docker makes it easy to run a variety of applications on your Unraid server, but...
(A_VARIETY_OF)
docs/unraid-os/troubleshooting/diagnostics/udma-crc-errors.md
[uncategorized] ~17-~17: This expression is usually spelled with a hyphen.
Context: ...g transmission. In the context of UDMA (ultra direct memory access), CRC errors mean the dat...
(ULTRA_HYPHEN)
docs/unraid-os/troubleshooting/faq.md
[typographical] ~27-~27: It appears that a comma is missing.
Context: ...ctor-allocation) - OS & Configuration - [Can I use a HASP key within a VM on Unraid?...
(COMMA_BEFORE_QUESTION_WITH_MD)
[style] ~53-~53: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...on code?](#redeem-activation-code) - [How do I upgrade my Unraid license?](#upgra...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~57-~57: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...C versions)?](#pre-release-policy) - [What does "unlimited" mean for attached stor...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~58-~58: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...rage devices?](#unlimited-storage) - [What happens if my USB flash device fails? D...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[misspelling] ~70-~70: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...m-purchase) --- ## Build & Hardware <a id="build-help" class="anchor-fix" styl...
(EN_A_VS_AN)
[misspelling] ~78-~78: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...level of experience.
<a id="hardware-raid-support" class="ancho...
(EN_A_VS_AN)
[misspelling] ~88-~88: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...tested successfully.
<a id="add-more-storage" class="anchor-fix...
(EN_A_VS_AN)
[misspelling] ~96-~96: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...rity and monitoring.
<a id="bad-sector-allocation" class="ancho...
(EN_A_VS_AN)
[misspelling] ~114-~114: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...ls>
--- ## OS & Configuration <a id="hasp-key-vm" class="anchor-fix" sty...
(EN_A_VS_AN)
[misspelling] ~122-~122: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...erforms as expected.
<a id="usb-failed-restore" class="anchor-f...
(EN_A_VS_AN)
[misspelling] ~130-~130: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...5-general-support/).
<a id="forgot-root-password" class="anchor...
(EN_A_VS_AN)
[misspelling] ~142-~142: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... is no backdoor. :::
<a id="factory-reset" class="anchor-fix" s...
(EN_A_VS_AN)
[grammar] ~147-~147: The word ‘Backup’ is a noun. Do you mean the verb “Back up”?
Context: ...>Click to expand/collapse 1. Backup any data you wish to keep. 2. Stop the ...
(SENT_START_BACKUP)
[misspelling] ~157-~157: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...p and configuration.
<a id="change-hostname" class="anchor-fix"...
(EN_A_VS_AN)
[misspelling] ~170-~170: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...ognize the new name.
<a id="invalid-guid" class="anchor-fix" st...
(EN_A_VS_AN)
[misspelling] ~191-~191: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... /> --- ## Virtualization & Devices <a id="amd-gpu-vm-restart" class="anchor-f...
(EN_A_VS_AN)
[misspelling] ~199-~199: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...y avoids this issue.
<a id="primary-gpu-passthrough" class="anc...
(EN_A_VS_AN)
[misspelling] ~207-~207: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...to do this properly.
<a id="rtx-gpu-passthrough" class="anchor-...
(EN_A_VS_AN)
[misspelling] ~249-~249: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...etails>
--- ## Storage & RAID <a id="raid-types-support" class="anchor-f...
(EN_A_VS_AN)
[misspelling] ~278-~278: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...age drives directly.
<a id="mbr-to-gpt-conversion" class="ancho...
(EN_A_VS_AN)
[misspelling] ~312-~312: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...
--- ## Networking <a id="disable-br0-bridge" class="anchor-f...
(EN_A_VS_AN)
[misspelling] ~324-~324: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...orking features. :::
<a id="webgui-connection" class="anchor-fi...
(EN_A_VS_AN)
[uncategorized] ~334-~334: “you” seems less likely than “you’re” (you are).
Context: ...d as "Tower" or something similar. - If you assigned a static IP during flash creat...
(AI_HYDRA_LEO_CP_YOU_YOUARE)
[misspelling] ~351-~351: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: .../details>
--- ## Installation <a id="usb-creator-issue" class="anchor-fi...
(EN_A_VS_AN)
[misspelling] ~359-~359: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...Debian/Ubuntu Linux.
<a id="uefi-boot-config" class="anchor-fix...
(EN_A_VS_AN)
[misspelling] ~382-~382: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...mode, if available).
<a id="webgui-browser-issues" class="ancho...
(EN_A_VS_AN)
[misspelling] ~398-~398: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...r browser or device.
<a id="extend-trial" class="anchor-fix" st...
(EN_A_VS_AN)
[misspelling] ~414-~414: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...:
--- ## Licensing <a id="own-license" class="anchor-fix" sty...
(EN_A_VS_AN)
[misspelling] ~422-~422: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... for future updates.
<a id="purchase-unraid" class="anchor-fix"...
(EN_A_VS_AN)
[misspelling] ~434-~434: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...all sales are final.
<a id="redeem-activation-code" class="anch...
(EN_A_VS_AN)
[misspelling] ~455-~455: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...y-step guidance. :::
<a id="upgrade-license" class="anchor-fix"...
(EN_A_VS_AN)
[misspelling] ~469-~469: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ..., lifetime updates
<a id="subscription" class="anchor-fix" st...
(EN_A_VS_AN)
[misspelling] ~485-~485: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...rent extension fee.
<a id="no-extension" class="anchor-fix" st...
(EN_A_VS_AN)
[style] ~492-~492: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...re updates or major version upgrades. - You remain eligible for patch releases and ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~493-~493: This is not the usual sequence for adjectives that have no special emphasis.
Context: ...your license lapsed at 7.1.0). - Once a new minor version is released (e.g., 7.2.0), only...
(EN_ADJ_ORDER)
[misspelling] ~499-~499: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...the latest updates.
<a id="pre-release-policy" class="anchor-f...
(EN_A_VS_AN)
[misspelling] ~513-~513: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...se for new updates.
<a id="unlimited-storage" class="anchor-fi...
(EN_A_VS_AN)
[misspelling] ~531-~531: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...er Unraid features.*
<a id="usb-failure-license" class="anchor-...
(EN_A_VS_AN)
[misspelling] ~553-~553: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...avoid data loss. :::
<a id="manual-keyfile-install" class="anch...
(EN_A_VS_AN)
[misspelling] ~579-~579: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...
<a id="guid-error" class="anchor-fix" styl...
(EN_A_VS_AN)
[misspelling] ~587-~587: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ..., Kingston, and PNY.
<a id="registration-type" class="anchor-fi...
(EN_A_VS_AN)
[misspelling] ~595-~595: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...egistration details.
<a id="trial-license" class="anchor-fix" s...
(EN_A_VS_AN)
[misspelling] ~607-~607: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...mes (details below).
<a id="trial-key-transfer" class="anchor-f...
(EN_A_VS_AN)
[misspelling] ~615-~615: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...ued on a new device.
<a id="oem-purchase" class="anchor-fix" st...
(EN_A_VS_AN)
🪛 markdownlint-cli2 (0.17.2)
docs/unraid-os/system-administration/maintain-and-update/upgrading-unraid.md
87-87: Bare URL used
(MD034, no-bare-urls)
docs/unraid-os/troubleshooting/common-issues/system-crashes-and-stability.md
120-120: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
docs/unraid-os/system-administration/secure-your-server/secure-your-outgoing-comms.md
16-16: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
docs/unraid-os/system-administration/advanced-tools/wake-on-lan.md
44-44: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
52-52: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
58-58: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
68-68: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
87-87: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
97-97: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
103-103: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
120-120: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
docs/unraid-os/troubleshooting/common-issues/unclean-shutdowns.md
120-120: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
docs/unraid-os/system-administration/secure-your-server/securing-your-connection.md
47-47: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
209-209: Link fragments should be valid
(MD051, link-fragments)
docs/unraid-os/system-administration/secure-your-server/tailscale.md
87-87: Bare URL used
(MD034, no-bare-urls)
docs/unraid-os/using-unraid-to/create-virtual-machines/overview-and-system-prep.md
25-25: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
38-38: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
143-143: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
144-144: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
145-145: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
docs/unraid-os/system-administration/secure-your-server/wireguard.md
23-23: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
49-49: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
65-65: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
70-70: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
89-89: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
docs/unraid-os/system-administration/maintain-and-update/changing-the-flash-device.md
104-104: Link fragments should be valid
(MD051, link-fragments)
128-128: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
docs/unraid-os/system-administration/secure-your-server/security-fundamentals.md
65-65: Link fragments should be valid
(MD051, link-fragments)
docs/unraid-os/using-unraid-to/create-virtual-machines/unraid-as-a-vm.md
46-46: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
56-56: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
129-129: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
docs/unraid-os/troubleshooting/common-issues/data-recovery.md
156-156: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
180-180: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
docs/unraid-os/advanced-configurations/optimize-storage/zfs-storage.md
39-39: Images should have alternate text (alt text)
(MD045, no-alt-text)
57-57: Images should have alternate text (alt text)
(MD045, no-alt-text)
72-72: Images should have alternate text (alt text)
(MD045, no-alt-text)
85-85: Images should have alternate text (alt text)
(MD045, no-alt-text)
93-93: Images should have alternate text (alt text)
(MD045, no-alt-text)
102-102: Images should have alternate text (alt text)
(MD045, no-alt-text)
114-114: Images should have alternate text (alt text)
(MD045, no-alt-text)
120-120: Images should have alternate text (alt text)
(MD045, no-alt-text)
154-154: Images should have alternate text (alt text)
(MD045, no-alt-text)
162-162: Images should have alternate text (alt text)
(MD045, no-alt-text)
177-177: Images should have alternate text (alt text)
(MD045, no-alt-text)
204-204: Images should have alternate text (alt text)
(MD045, no-alt-text)
232-232: Images should have alternate text (alt text)
(MD045, no-alt-text)
249-249: Images should have alternate text (alt text)
(MD045, no-alt-text)
287-287: Images should have alternate text (alt text)
(MD045, no-alt-text)
301-301: Images should have alternate text (alt text)
(MD045, no-alt-text)
docs/unraid-os/troubleshooting/diagnostics/capture-diagnostics-and-logs.md
155-155: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
docs/unraid-os/troubleshooting/faq.md
23-23: Link fragments should be valid
(MD051, link-fragments)
24-24: Link fragments should be valid
(MD051, link-fragments)
25-25: Link fragments should be valid
(MD051, link-fragments)
26-26: Link fragments should be valid
(MD051, link-fragments)
28-28: Link fragments should be valid
(MD051, link-fragments)
29-29: Link fragments should be valid
(MD051, link-fragments)
30-30: Link fragments should be valid
(MD051, link-fragments)
31-31: Link fragments should be valid
(MD051, link-fragments)
32-32: Link fragments should be valid
(MD051, link-fragments)
33-33: Link fragments should be valid
(MD051, link-fragments)
35-35: Link fragments should be valid
(MD051, link-fragments)
36-36: Link fragments should be valid
(MD051, link-fragments)
37-37: Link fragments should be valid
(MD051, link-fragments)
39-39: Link fragments should be valid
(MD051, link-fragments)
40-40: Link fragments should be valid
(MD051, link-fragments)
42-42: Link fragments should be valid
(MD051, link-fragments)
43-43: Link fragments should be valid
(MD051, link-fragments)
45-45: Link fragments should be valid
(MD051, link-fragments)
46-46: Link fragments should be valid
(MD051, link-fragments)
47-47: Link fragments should be valid
(MD051, link-fragments)
48-48: Link fragments should be valid
(MD051, link-fragments)
50-50: Link fragments should be valid
(MD051, link-fragments)
51-51: Link fragments should be valid
(MD051, link-fragments)
52-52: Link fragments should be valid
(MD051, link-fragments)
53-53: Link fragments should be valid
(MD051, link-fragments)
54-54: Link fragments should be valid
(MD051, link-fragments)
55-55: Link fragments should be valid
(MD051, link-fragments)
56-56: Link fragments should be valid
(MD051, link-fragments)
57-57: Link fragments should be valid
(MD051, link-fragments)
58-58: Link fragments should be valid
(MD051, link-fragments)
59-59: Link fragments should be valid
(MD051, link-fragments)
60-60: Link fragments should be valid
(MD051, link-fragments)
61-61: Link fragments should be valid
(MD051, link-fragments)
62-62: Link fragments should be valid
(MD051, link-fragments)
63-63: Link fragments should be valid
(MD051, link-fragments)
64-64: Link fragments should be valid
(MD051, link-fragments)
219-219: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
230-230: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
236-236: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
366-366: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
370-370: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
375-375: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: AWS Amplify Console Web Preview
🔇 Additional comments (3)
docs/unraid-os/system-administration/maintain-and-update/changing-the-flash-device.md (1)
104-106: Anchor link likely invalid
[USB flash creator](#using-the-usb-flash-creator)references a heading that lives inside a<TabItem>, so Docusaurus won’t generate that fragment. Users will be dumped at the top of the page.Consider linking to the external “Using the USB flash creator” heading (outside the tab) or replacing with a regular paragraph anchor.
docs/unraid-os/troubleshooting/diagnostics/capture-diagnostics-and-logs.md (1)
36-40: Verify thatDiagnostics.jpgexists instatic/img/The build is already failing on a missing image in another doc.
/img/Diagnostics.jpgwill resolve tostatic/img/Diagnostics.jpg; if this file is absent, the site will break again.Would you run a quick
fd Diagnostics.jpg static/img(or add the image) before merging?docs/unraid-os/troubleshooting/common-issues/boot-and-startup-failures.md (1)
15-17: Check that the target document still exists after the restructure
../../getting-started/set-up-unraid/create-your-bootable-media.mdwas moved/renamed in this PR.
Please confirm the link is still valid; otherwise users will hit a 404.
| ``` | ||
| ifconfig | ||
| ``` | ||
|
|
||
| Take note of the MAC address (listed as `ether`). | ||
|
|
||
| 3. Enable WoL on the interface: | ||
|
|
||
| ``` | ||
| ethtool -s eth0 wol g | ||
| ``` | ||
|
|
||
| 4. Put the server to sleep: | ||
|
|
||
| ``` | ||
| echo -n mem > /sys/power/state | ||
| ``` | ||
|
|
||
| :::caution Persistence | ||
| WoL settings are **not persistent** across reboots. To make them permanent: | ||
|
|
||
| 1. Create a `go` file on your flash drive at `/boot/config/go`. | ||
| 2. Add this line: | ||
|
|
||
| ``` | ||
| /sbin/ethtool -s eth0 wol g | ||
| ``` |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Specify a language for all fenced code blocks
markdownlint flags MD040 on each un-annotated block; adding a language identifier (bash / powershell) improves syntax-highlighting and lint compliance.
- ```
+ ```bash
ifconfig
@@
- ```
+ ```bash
ethtool -s eth0 wol g
@@
- ```
+ ```bash
echo -n mem > /sys/power/state
@@
-```
+/```bash
/sbin/ethtool -s eth0 wol g
@@
- ```
+ ```powershell
wolcmd.exe <MAC_ADDRESS> <SERVER_IP> 255.255.255.255
@@
- ```
+ ```bash
brew install wakeonlan
@@
- ```
+ ```bash
wakeonlan MAC_ADDRESS
@@
- ```
+ ```bash
wakeonlan MAC_ADDRESSAlso applies to: 87-105, 120-122
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
44-44: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
52-52: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
58-58: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
68-68: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In docs/unraid-os/system-administration/advanced-tools/wake-on-lan.md around
lines 44 to 70, the fenced code blocks lack language identifiers, causing
markdownlint MD040 warnings and missing syntax highlighting. Add appropriate
language tags such as bash or powershell to all fenced code blocks in this
range, and also apply the same fix to lines 87-105 and 120-122 to ensure
consistent syntax highlighting and lint compliance.
|
|
||
| **Option 3: Manual folder rename** | ||
|
|
||
| - On the flash drive, rename the `efi-` folder to `efi` (remove the dash `-`). |
There was a problem hiding this comment.
Incorrect folder name for enabling UEFI boot
Past docs (and translations) use the tilde-suffixed folder EFI~ / efi~, not efi-.
Please update to avoid confusing users following older guides.
- On the flash drive, rename the `efi-` folder to `efi` (remove the dash `-`).
+ On the flash drive, rename the `efi~` folder to `EFI` (remove the tilde `~` and capitalise).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - On the flash drive, rename the `efi-` folder to `efi` (remove the dash `-`). | |
| - On the flash drive, rename the `efi~` folder to `EFI` (remove the tilde `~` and capitalise). |
🤖 Prompt for AI Agents
In docs/unraid-os/troubleshooting/faq.md at line 377, the folder name mentioned
for enabling UEFI boot is incorrect; it should be `efi~` instead of `efi-`.
Update the text to instruct users to rename the `efi-` folder to `efi~` (with a
tilde) to align with past documentation and avoid confusion.
| <Tabs> | ||
| <TabItem value="via-webgui" label="Via WebGui" default> | ||
| - Navigate to **Docker > Containers** | ||
| - Click the **Logs** icon for the desired container | ||
| </TabItem> | ||
|
|
||
| <TabItem value="commandline" label="Via Command Line" default> | ||
|
|
||
| Use the command: | ||
|
|
||
| ```bash | ||
| docker logs [container_name] > /path/to/save/log.txt | ||
| ``` | ||
|
|
||
| </TabItem> | ||
|
|
||
| <TabItem value="persistent" label="Persistent logging" default> | ||
|
|
||
| To map container logs to a host path, configure your container template like this: | ||
|
|
||
| ``` | ||
| /path/in/container:/logs | ||
| ``` | ||
|
|
||
| </TabItem> | ||
| </Tabs> |
There was a problem hiding this comment.
Only one <TabItem> should carry the default prop
Docusaurus v2 allows a single TabItem per Tabs block to be flagged as default.
Having three default attributes triggers a compile-time MDX error.
-<TabItem value="via-webgui" label="Via WebGui" default>
+<TabItem value="via-webgui" label="Via WebGUI" default>
...
-<TabItem value="commandline" label="Via Command Line" default>
+<TabItem value="commandline" label="Via Command Line">
...
-<TabItem value="persistent" label="Persistent logging" default>
+<TabItem value="persistent" label="Persistent logging">🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
155-155: Fenced code blocks should have a 10000 language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In docs/unraid-os/troubleshooting/diagnostics/capture-diagnostics-and-logs.md
between lines 135 and 160, the Tabs component has multiple TabItem elements
marked with the default prop, which causes a compile-time MDX error. Remove the
default attribute from all but one TabItem so that only a single TabItem has the
default prop to fix the issue.
| - **Use a UPS:** Keep your server connected to an Uninterruptible Power Supply (UPS) and set it up to initiate a controlled shutdown when battery power runs low. | ||
| - **Attempt a graceful shutdown:** If your server is unresponsive, briefly press the power button to trigger a safe shutdown. Do not hold the button down, as this will force a hard power off and lead to an unclean shutdown. | ||
| - **Enable persistent logging:** Go to **Settings > Syslog Server** to activate logging that persists after a reboot. See [Persistent logs (Syslog server)](./diagnostics-information.md#persistent-logs-syslog-server) for more details. | ||
| - **Attach diagnostics for support:** If an unclean shutdown occurs, Unraid will attempt to save diagnostics to `/log/diagnostics.zip` on your flash device. Attach this file to forum posts when you seek help. | ||
| ::: |
There was a problem hiding this comment.
Broken relative link to diagnostics guide
[Persistent logs (Syslog server)](./diagnostics-information.md#persistent-logs-syslog-server) points to a file that doesn’t exist in the new tree.
From common-issues/, the correct path is the neighbouring diagnostics folder.
-[Persistent logs (Syslog server)](./diagnostics-information.md#persistent-logs-syslog-server)
+[Persistent logs (Syslog server)](../diagnostics/capture-diagnostics-and-logs.md#persistent-logs-syslog-server)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - **Use a UPS:** Keep your server connected to an Uninterruptible Power Supply (UPS) and set it up to initiate a controlled shutdown when battery power runs low. | |
| - **Attempt a graceful shutdown:** If your server is unresponsive, briefly press the power button to trigger a safe shutdown. Do not hold the button down, as this will force a hard power off and lead to an unclean shutdown. | |
| - **Enable persistent logging:** Go to **Settings > Syslog Server** to activate logging that persists after a reboot. See [Persistent logs (Syslog server)](./diagnostics-information.md#persistent-logs-syslog-server) for more details. | |
| - **Attach diagnostics for support:** If an unclean shutdown occurs, Unraid will attempt to save diagnostics to `/log/diagnostics.zip` on your flash device. Attach this file to forum posts when you seek help. | |
| ::: | |
| - **Use a UPS:** Keep your server connected to an Uninterruptible Power Supply (UPS) and set it up to initiate a controlled shutdown when battery power runs low. | |
| - **Attempt a graceful shutdown:** If your server is unresponsive, briefly press the power button to trigger a safe shutdown. Do not hold the button down, as this will force a hard power off and lead to an unclean shutdown. | |
| - **Enable persistent logging:** Go to **Settings > Syslog Server** to activate logging that persists after a reboot. See [Persistent logs (Syslog server)](../diagnostics/capture-diagnostics-and-logs.md#persistent-logs-syslog-server) for more details. | |
| - **Attach diagnostics for support:** If an unclean shutdown occurs, Unraid will attempt to save diagnostics to `/log/diagnostics.zip` on your flash device. Attach this file to forum posts when you seek help. | |
| ::: |
🤖 Prompt for AI Agents
In docs/unraid-os/troubleshooting/common-issues/unclean-shutdowns.md around
lines 17 to 21, the relative link to the diagnostics guide is broken because it
points to a non-existent file path. Update the link to correctly reference the
diagnostics folder adjacent to common-issues by adjusting the relative path to
point to ../diagnostics/diagnostics-information.md#persistent-logs-syslog-server
so it resolves properly.
| ## Ways to access your WebGUI | ||
|
|
||
| Below are the main ways to access your Unraid WebGUI, depending on your SSL configuration: | ||
|
|
||
| #### HTTP-only (unencrypted) |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Heading level jumps from ## to ####
Markdown-lint MD001 flags the level-skip.
Use ### for the immediate children of “Ways to access your WebGUI”.
-#### HTTP-only (unencrypted)
+### HTTP-only (unencrypted)Apply the same change to the subsequent “HTTPS …” sections.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## Ways to access your WebGUI | |
| Below are the main ways to access your Unraid WebGUI, depending on your SSL configuration: | |
| #### HTTP-only (unencrypted) | |
| ## Ways to access your WebGUI | |
| Below are the main ways to access your Unraid WebGUI, depending on your SSL configuration: | |
| ### HTTP-only (unencrypted) |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
47-47: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
🤖 Prompt for AI Agents
In
docs/unraid-os/system-administration/secure-your-server/securing-your-connection.md
around lines 43 to 47, the heading level jumps from ## to ####, which violates
markdown-lint MD001. Change the #### headings under "Ways to access your WebGUI"
to ### to maintain proper heading hierarchy. Also, update all subsequent similar
"HTTPS ..." section headings to ### for consistency.
| When you go to the **Shares** tab and select a share, you’ll see its settings, including a security section where you can manage [access permissions](#configuring-share-visibility) based on the protocols you have enabled. This way, you can tailor who has access to your files depending on their needs. | ||
|
|
There was a problem hiding this comment.
Broken self-reference: fix anchor link
#configuring-share-visibility does not exist; the generated slug is #managing-network-visibility-of-shares.
- manage [access permissions](#configuring-share-visibility) based on the protocols you have enabled.
+ manage [access permissions](#managing-network-visibility-of-shares) based on the protocols you have enabled.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| When you go to the **Shares** tab and select a share, you’ll see its settings, including a security section where you can manage [access permissions](#configuring-share-visibility) based on the protocols you have enabled. This way, you can tailor who has access to your files depending on their needs. | |
| When you go to the **Shares** tab and select a share, you’ll see its settings, including a security section where you can manage [access permissions](#managing-network-visibility-of-shares) based on the protocols you have enabled. This way, you can tailor who has access to your files depending on their needs. |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
65-65: Link fragments should be valid
(MD051, link-fragments)
🤖 Prompt for AI Agents
In
docs/unraid-os/system-administration/secure-your-server/security-fundamentals.md
around lines 65 to 66, the anchor link #configuring-share-visibility is broken
because the correct slug is #managing-network-visibility-of-shares. Update the
link to use the correct anchor #managing-network-visibility-of-shares to fix the
self-reference.
* Fix case issue with Switch_toggle_icon.png * Add AI-generated script to check for case sensitivity issues when building on Windows
Before Submitting This PR, Please Ensure You Have Completed The Following:
Summary by CodeRabbit
New Features
Documentation