5-30 changes #283
5-30 changes #283
Conversation
|
Warning Rate limit exceeded@ljm42 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 13 minutes and 54 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (3)
📝 WalkthroughWalkthroughThis update extensively restructures the Unraid documentation by removing a large number of markdown and JSON files across API, account, connect, legacy, FAQ, manual, guides, and overview sections. Simultaneously, it introduces new and reorganized documentation under the "getting started" area, including new guides for setup, key features, and Unraid account information. The release notes for versions 7.0.0 and 7.0.1 are also reformatted for clarity. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant DocsHome
participant GettingStarted
participant SetupGuides
participant WebGUI
participant UnraidNet
User->>DocsHome: Visit documentation home page
DocsHome->>GettingStarted: Link to "What is Unraid?" and setup guides
User->>GettingStarted: Read overview and requirements
GettingStarted->>SetupGuides: Follow steps to create boot media, deploy OS, configure array, customize settings
SetupGuides->>WebGUI: User interacts with WebGUI for configuration
SetupGuides->>UnraidNet: Optionally create/manage Unraid.net account
User->>WebGUI: Explore key features and tour interface
Possibly related PRs
Poem
✨ Finishing Touches
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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 20
🧹 Nitpick comments (20)
docs/unraid-os/release-notes/7.0.0.md (4)
95-95: Grammar: “MacOS” should be “macOS”
Apple’s operating system is officially styled “macOS”.- - Samba: improved IPv6 support, MacOS Time Machine compatibility restored. + - Samba: improved IPv6 support, macOS Time Machine compatibility restored.🧰 Tools
🪛 LanguageTool
[grammar] ~95-~95: The operating system from Apple is written “macOS”.
Context: ...ported. - Samba: improved IPv6 support, MacOS Time Machine compatibility restored. - ...(MAC_OS)
106-106: Grammar: “MacOS” should be “macOS”
Consistency with Apple’s branding.- - Fix for MacOS unable to write to 'flash' share. + - Fix for macOS unable to write to 'flash' share.🧰 Tools
🪛 LanguageTool
[grammar] ~106-~106: The operating system from Apple is written “macOS”.
Context: ...nfsd not restarting properly. - Fix for MacOS unable to write to 'flash' share. --- ...(MAC_OS)
136-136: Style: Avoid weak intensifier “very”
Consider using “outdated” or “legacy” in place of “very old”.- - Replace very old 'memtest' with Memtest86+ version 6.20. + - Replace legacy 'memtest' with Memtest86+ version 6.20.🧰 Tools
🪛 LanguageTool
[style] ~136-~136: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...ellaneous Other Changes: - Replace very old 'memtest' with Memtest86+ version 6.20....(EN_WEAK_ADJECTIVE)
569-569: Grammar: Use “roll back” as a verb
“Rollback” is a noun; the verb form should be two words.- - If you rollback to an earlier version, you will need to reinstall those plugins to retain their functionality. + - If you roll back to an earlier version, you will need to reinstall those plugins to retain their functionality.🧰 Tools
🪛 LanguageTool
[grammar] ~569-~569: The word “rollback” is a noun. The verb is spelled with a space.
Context: ...ugins are now built into Unraid. If you rollback to an earlier version, you will need to...(NOUN_VERB_CONFUSION)
docs/unraid-os/getting-started/_category_.json (1)
2-3: Ensure an index page or generated index is configured.You removed the
"link"entry in favor of a simplelabel/position. Without alink(or anindex.md/generated-index), Docusaurus may not render a landing page for this category. Please verify that anindex.mdexists in this folder or add a"link": { "type": "generated-index" }block to_category_.json.docs/docs-home.md (1)
15-15: Remove personal note from landing page.The greeting ("Hi Larry… Have a great day!") appears to be a private or placeholder message. Please replace it with a neutral, public-facing introduction before merging.
🧰 Tools
🪛 LanguageTool
[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/unraid-net.md (3)
8-8: Add missing comma after “benefits”
To clarify the sentence structure, insert a comma before “such as”:-…having an account provides several benefits such as streamlined license management… +…having an account provides several benefits, such as streamlined license management…🧰 Tools
🪛 LanguageTool
[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)
12-16: Ensure consistent hyphenation of “multifactor authentication”
The phrase “multi-factor authentication (MFA)” appears here and later with different styling. Choose either “multifactor authentication (MFA)” (one word) or consistently hyphenate every occurrence.🧰 Tools
🪛 LanguageTool
[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)
20-20: Use the correct article before “SSO”
Since “SSO” begins with a vowel sound, change “a SSO system” to “an SSO system”:-Unraid.net uses a SSO system at account.unraid.net for secure authentication via AWS Cognito. +Unraid.net uses an SSO system at account.unraid.net for secure authentication via AWS Cognito.🧰 Tools
🪛 LanguageTool
[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)
docs/unraid-os/getting-started/explore-the-user-interface/key-features.md (1)
8-8: Add comma before dependent clause
Insert a comma after “tasks” to improve readability:-…common tasks while also offering advanced tuning options… +…common tasks, while also offering advanced tuning options…🧰 Tools
🪛 LanguageTool
[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)
docs/unraid-os/getting-started/set-up-unraid/complete-your-post-setup-essentials.md (2)
27-27: Remove duplicated words in sentence
The phrase “information help information” is duplicated. Consider rewriting to:-…offer the most up-to-date information help information. +…offer the most up-to-date help information.🧰 Tools
🪛 LanguageTool
[grammar] ~27-~27: The usual preposition to use with “corner” is “in”, not “on”. Did you mean “in the top-right corner”?
Context: ...heicon at the top-right corner. You can also toggle help on individual...
(ON_IN_THE_CORNER_2)
27-27: Use correct preposition for location
Change “on the top-right corner” to “in the top-right corner” for standard usage:-…clicking the  icon at the top-right corner. +…clicking the  icon in the top-right corner.🧰 Tools
🪛 LanguageTool
[grammar] ~27-~27: The usual preposition to use with “corner” is “in”, not “on”. Did you mean “in the top-right corner”?
Context: ...he(ON_IN_THE_CORNER_2)
docs/unraid-os/getting-started/set-up-unraid/create-your-bootable-media.md (3)
16-16: Use “installation” instead of “install” in section title
For grammatical consistency, change “install method” to “installation method”:-## Automated install method +## Automated installation method🧰 Tools
🪛 LanguageTool
[grammar] ~16-~16: The word ‘install’ is not a noun.
Context: ...o format as FAT32. ::: ## Automated install method The automated installation meth...(A_INSTALL)
36-36: Use “installation” instead of “install” in section title
For consistency with the automated section, update:-## Manual install method +## Manual installation method🧰 Tools
🪛 LanguageTool
[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)
68-68: Specify language for fenced code block
Add a language identifier for syntax highlighting:-``` +```bash🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
68-68: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.md (1)
91-94: Rephrase troubleshooting intro and series punctuation
Avoid the colon before a “to” list and the extra colon after “to:”. You could combine the tips inline or adjust as shown:-If Unraid OS does not boot, try: - ✅ Adjusting the boot order to: **Forced-FDD**, **USB-HDD**, **USB-ZIP**. +If Unraid OS does not boot, try adjusting the boot order to **Forced-FDD**, **USB-HDD**, **USB-ZIP**, disabling USB 2.0/3.0 support, toggling any **Fast Boot** features, or toggling USB keyboard support.🧰 Tools
🪛 LanguageTool
[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/explore-the-user-interface/tour-the-web-gui.md (1)
11-12: Convert plain underline tags into proper links or emphasis
The<u>Community Applications section</u>text isn’t linked. If you intend to link to that section, use a markdown link ([Community Applications](...)). Otherwise, replace the<u>tags with*…*or**…**for emphasis.docs/unraid-os/getting-started/set-up-unraid/customize-unraid-settings.md (1)
9-9: Consistent JSX style formatting
In the<div>tag at line 9, consider adding a space before the closing brace for consistency:- <div style={{ margin: 'auto', maxWidth: '700px'}}> + <div style={{ margin: 'auto', maxWidth: '700px' }}>docs/unraid-os/getting-started/what-is-unraid.md (2)
20-20: Refine wording for clarity and consistency
- Line 20: Consider replacing “a variety of drives” with “different drives.”
- Line 63: Use “exclude” instead of “leave out.”
- Line 83: Simplify “not only increases ... but also uses” to “increases ... and uses.”
- Line 110: Standardize on “preconfigured” (not both “pre-configured” and “preconfigure”).
Also applies to: 63-63, 83-83, 110-110
🧰 Tools
🪛 LanguageTool
[style] ~20-~20: 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)
187-189: Convert cross-reference into a proper link
The reference to “Using Unraid to > Create virtual machines” is plain text. If this should link to another doc, change it to a markdown link (e.g.,[Create virtual machines](../../manual/vm-management/)).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (160)
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/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!**/*.pngstatic/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/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/feedback.pngis excluded by!**/*.pngstatic/img/filemanager.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!**/*.pngstatic/img/logout.pngis excluded by!**/*.pngstatic/img/maintab.pngis excluded by!**/*.pngstatic/img/navbar2.pngis excluded by!**/*.pngstatic/img/navbar3.pngis excluded by!**/*.pngstatic/img/notificationicon.pngis excluded by!**/*.pngstatic/img/peer-add.pngis excluded by!**/*.pngstatic/img/peer-eye.pngis excluded by!**/*.pngstatic/img/peer-view.pngis excluded by!**/*.pngstatic/img/pluginstab.pngis excluded by!**/*.pngstatic/img/primarytosecondarystorage.pngis excluded by!**/*.pngstatic/img/rootuser.pngis excluded by!**/*.pngstatic/img/rootuservsshareusers.pngis excluded by!**/*.pngstatic/img/settings-confirmations.pngis excluded by!**/*.pngstatic/img/settings-console.pngis excluded by!**/*.pngstatic/img/settings-display.pngis excluded by!**/*.pngstatic/img/settings-docker.pngis excluded by!**/*.pngstatic/img/settings-ftp.pngis excluded by!**/*.pngstatic/img/settings-globalshare.pngis excluded by!**/*.pngstatic/img/settings-identification.pngis excluded by!**/*.pngstatic/img/settings-management-access.pngis excluded by!**/*.pngstatic/img/settings-network.pngis excluded by!**/*.pngstatic/img/settings-nfs.pngis excluded by!**/*.pngstatic/img/settings-notifications.pngis excluded by!**/*.pngstatic/img/settings-powermode.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/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)docs/unraid-os/overview/what-is-unraid.md(0 hunks)docs/unraid-os/release-notes/7.0.0.md(1 hunks)docs/unraid-os/release-notes/7.0.1.md(1 hunks)
⛔ Files not processed due to max files limit (32)
- 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/secure-your-server/category.json
- 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/manage-storage/category.json
- docs/unraid-os/using-unraid-to/manage-storage/array-configuration.md
- docs/unraid-os/using-unraid-to/manage-storage/shares.md
- src/components/Card/CardBody/index.js
- src/components/Card/CardFooter/index.js
- src/components/Card/CardHeader/index.js
- src/components/Card/CardImage/index.js
- src/components/Card/index.js
- src/css/custom.css
- src/hooks/useIframe.ts
- src/theme/Layout/IframeNavigation.tsx
- src/theme/Layout/ThemeSync.tsx
- src/theme/Layout/index.tsx
💤 Files with no reviewable changes (91)
- docs/connect/category.json
- docs/account/category.json
- docs/unraid-os/faq/category.json
- docs/unraid-os/manual/category.json
- docs/legacy/category.json
- docs/account/account.md
- docs/API/category.json
- docs/unraid-os/overview/category.json
- docs/unraid-os/manual/zfs/category.json
- docs/unraid-os/manual/vm/category.json
- docs/unraid-os/manual/users/category.json
- docs/unraid-os/guides/category.json
- docs/unraid-os/manual/security/security.md
- docs/unraid-os/manual/shares/category.json
- docs/connect/index.md
- docs/unraid-os/manual/users/create-user.md
- docs/unraid-os/manual/users/manage-user.md
- docs/API/upcoming-features.md
- docs/unraid-os/manual/security/category.json
- docs/account/link-key.md
- docs/unraid-os/faq/installation.md
- docs/unraid-os/manual/shares/delete-a-share.md
- docs/connect/help.md
- docs/legacy/FAQ/check-harddrive-speed.md
- docs/API/cli.md
- docs/unraid-os/getting-started/advanced-bios-config.md
- docs/API/index.md
- docs/unraid-os/overview/unraid-management.md
- docs/unraid-os/faq/redeem-license-activation-code.md
- docs/unraid-os/manual/multi-language.md
- docs/connect/privacy.md
- docs/unraid-os/overview/what-is-unraid.md
- docs/API/how-to-use-the-api.md
- docs/unraid-os/guides/configuring-time-machine.md
- docs/unraid-os/getting-started/manual-install-method.md
- docs/legacy/Articles/expanding-windows-vm-vdisk-partitions.md
- docs/unraid-os/manual/security/data-encryption.md
- docs/unraid-os/manual/shares/disk-shares.md
- docs/unraid-os/manual/users/users.md
- docs/unraid-os/getting-started/considerations.md
- docs/unraid-os/manual/users/reset-password.md
- docs/unraid-os/manual/shares/shares.md
- docs/unraid-os/manual/tools.md
- docs/legacy/FAQ/transferring-files-from-a-network-share-to-unraid.md
- docs/connect/flash-backup.md
- docs/unraid-os/manual/security/secure-webgui-ssl.md
- docs/unraid-os/manual/shares/create-a-share.md
- docs/legacy/Articles/upgrading-to-unraid-6.md
- docs/unraid-os/manual/security/tailscale.md
- docs/unraid-os/overview/virtualization-host.md
- docs/unraid-os/manual/applications.md
- docs/unraid-os/guides/wol-setup-for-unraid.md
- docs/unraid-os/manual/security/outgoing-proxy-manager.md
- docs/legacy/FAQ/replacing-multiple-data-drives.md
- docs/unraid-os/overview/application-server.md
- docs/legacy/FAQ/setup-sleep-and-wake-on-lan.md
- docs/legacy/FAQ/terminal-access.md
- docs/connect/remote-access.md
- docs/unraid-os/faq/os-faq.md
- docs/unraid-os/manual/vm/vm-management.md
- docs/unraid-os/manual/shares/network-access.md
- docs/unraid-os/guides/convert-windows-to-vm.md
- docs/unraid-os/manual/security/flash-drive.md
- docs/unraid-os/faq/licensing-faq.md
- docs/legacy/FAQ/replacing-a-data-drive.md
- docs/unraid-os/getting-started/quick-install-guide.md
- docs/legacy/FAQ/setting-up-cpu-and-board-temperature-sensing.md
- docs/legacy/FAQ/cache-disk.md
- docs/legacy/FAQ/transferring-files-within-the-unraid-server.md
- docs/legacy/FAQ/Parity.md
- docs/unraid-os/manual/docker-management.md
- docs/unraid-os/overview/ui-reference.md
- docs/legacy/FAQ/usb-flash-drive-preparation.md
- docs/legacy/FAQ/console.md
- docs/legacy/FAQ/understanding-smart-reports.md
- docs/legacy/Articles/dual-boot-unraid-and-windows.md
- docs/unraid-os/manual/additional-settings.md
- docs/unraid-os/manual/security/good-practices.md
- docs/unraid-os/manual/upgrade-instructions.md
- docs/unraid-os/manual/zfs/placeholder.md
- docs/unraid-os/getting-started/getting-started.md
- docs/unraid-os/guides/physical-to-virtual.md
- docs/legacy/FAQ/shrink-array.md
- docs/legacy/FAQ/parity-swap-procedure.md
- docs/unraid-os/manual/vm/vm-support.md
- docs/unraid-os/guides/xen-to-kvm.md
- docs/unraid-os/manual/changing-the-flash-device.md
- docs/unraid-os/overview/nas.md
- docs/unraid-os/manual/security/vpn.md
- docs/legacy/FAQ/check-disk-filesystems.md
- docs/unraid-os/manual/shares/user-shares.md
🧰 Additional context used
🪛 LanguageTool
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/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/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)
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)
[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/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)
docs/unraid-os/getting-started/what-is-unraid.md
[style] ~20-~20: 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] ~63-~63: 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] ~83-~83: 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] ~110-~110: 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/release-notes/7.0.0.md
[grammar] ~95-~95: The operating system from Apple is written “macOS”.
Context: ...ported. - Samba: improved IPv6 support, MacOS Time Machine compatibility restored. - ...
(MAC_OS)
[grammar] ~106-~106: The operating system from Apple is written “macOS”.
Context: ...nfsd not restarting properly. - Fix for MacOS unable to write to 'flash' share. --- ...
(MAC_OS)
[style] ~136-~136: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...ellaneous Other Changes: - Replace very old 'memtest' with Memtest86+ version 6.20....
(EN_WEAK_ADJECTIVE)
[grammar] ~228-~228: Make sure that the singular noun after the number ‘1.3’ is correct.
Context: ...n: version 2.16.0 - beep: version 1.3 - bin: version 11.1 - bind: version 9.20.4 - ...
(CD_POINT_CD_NN)
[grammar] ~229-~229: Make sure that the singular noun after the number ‘11.1’ is correct.
Context: ...beep: version 1.3 - bin: version 11.1 - bind: version 9.20.4 - bluez-firmware: versi...
(CD_POINT_CD_NN)
[grammar] ~256-~256: Make sure that the singular noun after the number ‘2.90’ is correct.
Context: ...: version 3.6 - dnsmasq: version 2.90 - docker: version 27.0.3 - dosfstools: version 4...
(CD_POINT_CD_NN)
[style] ~265-~265: In American English, abbreviations like “etc.” require a period.
Context: ...sion 2.2_0 - encodings: version 1.1.0 - etc: version 15.1 - ethtool: version 5.19 -...
(ETC_PERIOD)
[grammar] ~427-~427: Possible agreement error. The noun ‘mesa’ seems to be countable.
Context: ... version 4.8.31 - mcelog: version 202 - mesa: version 24.2.8 - miniupnpc: version 2....
(CD_NN)
[grammar] ~479-~479: Make sure that the singular noun after the number ‘1.48’ is correct.
Context: ...rsion 1.3.4 - sg3_utils: version 1.48 - shadow: version 4.16.0 - shared-mime-info: ver...
(CD_POINT_CD_NN)
[grammar] ~483-~483: Make sure that the singular noun after the number ‘7.4’ is correct.
Context: ...on 1.3.6 - smartmontools: version 7.4 - spice: version 0.15.0 - spirv-llvm-translator...
(CD_POINT_CD_NN)
[grammar] ~569-~569: The word “rollback” is a noun. The verb is spelled with a space.
Context: ...ugins are now built into Unraid. If you rollback to an earlier version, you will need to...
(NOUN_VERB_CONFUSION)
🪛 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/release-notes/7.0.0.md
84-84: Link fragments should be valid
null
(MD051, link-fragments)
601-601: Link fragments should be valid
null
(MD051, link-fragments)
🪛 GitHub Actions: Build PR
docs/unraid-os/getting-started/set-up-unraid/configure-your-array.md
[error] 1-1: MDX compilation failed: Image static/img/configuringarray1.png used in this file was not found.
🔇 Additional comments (6)
docs/unraid-os/release-notes/7.0.1.md (1)
1-118: LGTM
The 7.0.1 release notes are well-structured, grammatically sound, and all links resolve correctly.docs/unraid-os/getting-started/explore-the-user-interface/_category_.json (1)
1-4: Category metadata looks correct.The
labelandpositionalign with the intended sidebar layout under Getting Started. Ensure that theexplore-the-user-interfacefolder contains the relevant markdown files to populate this section.docs/unraid-os/getting-started/set-up-unraid/_category_.json (1)
1-4: Category metadata looks correct.The
label: "Set up Unraid"andposition: 3appropriately define this group in the sidebar. Confirm that you’ve added the expected guides in this directory.docs/docs-home.md (3)
6-6: Verify Term component integration.You’ve imported
Termfrom@lunaticmuch/docusaurus-terminology. Ensure this plugin is listed and configured indocusaurus.config.js, or the tooltip component will not render.
9-9: Approve header section.The
# Homeheading is concise and appropriate for the documentation’s landing page.
11-11: Approve subheading.The
## Unraid Documentationsubheading clearly introduces the content below.
|
|
||
| #### ZFS pools | ||
| **Note:** See [Add support for overlay2 storage driver](#add-support-for-overlay2-storage-driver) for ZFS-specific guidance. |
There was a problem hiding this comment.
Broken link: Invalid anchor reference
The link [Add support for overlay2 storage driver](#add-support-for-overlay2-storage-driver) points to a non-existent heading.
Suggested fix:
- **Note:** See [Add support for overlay2 storage driver](#add-support-for-overlay2-storage-driver) for ZFS-specific guidance.
+ **Note:** See [Overlay2 storage driver support](#overlay2-storage-driver-support) for ZFS-specific guidance.(Also ensure a matching ## Overlay2 storage driver support section exists or adjust the anchor accordingly.)
📝 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:** See [Add support for overlay2 storage driver](#add-support-for-overlay2-storage-driver) for ZFS-specific guidance. | |
| **Note:** See [Overlay2 storage driver support](#overlay2-storage-driver-support) for ZFS-specific guidance. |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
84-84: Link fragments should be valid
null
(MD051, link-fragments)
🤖 Prompt for AI Agents
In docs/unraid-os/release-notes/7.0.0.md at line 84, the link anchor
#add-support-for-overlay2-storage-driver does not match any existing heading.
Verify that a heading like "## Overlay2 storage driver support" exists in the
document; if not, create it or update the link anchor to match the exact heading
text converted to an anchor. Ensure the anchor in the link corresponds exactly
to the heading's slug to fix the broken link.
| - @bonienl for merging the Dynamix File Manager plugin into the webgui. | ||
| - @Squid for merging the GUI Search and Unlimited Width Plugin plugins into the webgui. | ||
| - @ludoux (Proxy Editor plugin) and @Squid (Community Applications plugin) for pioneering the work on http proxy support, several ideas of which have been incorporated into the webgui. | ||
| - @ich777 for maintaining third-party driver plugins, and for the [Tailscale Docker integration](#tailscale-integration). |
There was a problem hiding this comment.
Broken link: Missing “Tailscale Docker integration” anchor
The reference [#tailscale-integration] in the special thanks list does not match any heading.
Suggested fix:
- - @ich777 for maintaining third-party driver plugins, and for the [Tailscale Docker integration](#tailscale-integration).
+ - @ich777 for maintaining third-party driver plugins, and for the [Tailscale Docker integration](#t ealign-tailscale-docker-integration).Ensure the heading ## Tailscale Docker integration (or similar) exists, or update the link to the correct anchor name.
Committable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
601-601: Link fragments should be valid
null
(MD051, link-fragments)
🤖 Prompt for AI Agents
In docs/unraid-os/release-notes/7.0.0.md at line 601, the link reference
[#tailscale-integration] points to a non-existent anchor. To fix this, verify
that a heading like "## Tailscale Docker integration" exists in the document to
create the correct anchor, or update the link to match the actual heading anchor
name present in the file.
| --- | ||
| id: glossary | ||
| title: Glossary | ||
| --- |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Populate glossary with definitions.
The new glossary.md file contains only front matter and no term entries. To enable tooltip lookups (e.g., for AHCI), please add your glossary definitions or import mechanism so that terms resolve correctly.
🤖 Prompt for AI Agents
In docs/glossary.md at the beginning of the file (lines 1 to 4), the glossary
currently only contains front matter without any term definitions. To fix this,
add glossary entries with terms and their definitions below the front matter, or
implement an import mechanism to include existing definitions. This will enable
tooltip lookups for terms like AHCI to work correctly.
docs/docs-home.md
Outdated
|
|
||
| ### [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 path separators in term reference.
The reference attribute uses backslashes (\docs\terms\AHCI), which may not resolve correctly. Change to forward slashes and verify the path matches your glossary file structure:
- reference="\docs\terms\AHCI"
+ reference="docs/terms/AHCI"📝 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 reference attribute in the Term tag uses
backslashes for the path (\docs\terms\AHCI), which can cause resolution issues.
Replace the backslashes with forward slashes to form a correct relative path
like /docs/terms/AHCI, ensuring it matches the actual glossary file structure.
|
|
||
| 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.
🛠️ Refactor suggestion
Correct heading level and remove trailing colon
The h4 heading skips levels and ends with a colon. Use a h2 or h3 and drop 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, the heading is
currently an h4 that skips heading levels and ends with a colon. Change the
heading to either h2 or h3 to maintain proper heading hierarchy and remove the
trailing colon from the heading text.
| --- | ||
| sidebar_position: 2 | ||
| --- |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add a sidebar_label to frontmatter
This file specifies only sidebar_position. To control the label shown in the sidebar, please include a sidebar_label (e.g., sidebar_label: Tour the WebGUI).
🤖 Prompt for AI Agents
In docs/unraid-os/getting-started/explore-the-user-interface/tour-the-web-gui.md
at lines 1 to 3, the frontmatter currently only includes sidebar_position. Add a
sidebar_label field to the frontmatter with a descriptive label such as "Tour
the WebGUI" to control the label shown in the sidebar.
|
|
||
| ### Docker | ||
|
|
||
| Docker containers allow you to integrate pre-configured Linux applications into your Unraid server. For more details, see the [Docker Management](https://docs.unraid.net/unraid-os/manual/docker-management/) page. | ||
|
|
There was a problem hiding this comment.
Use a relative link for the Docker Management manual
The link to the Docker Management page is absolute (https://docs.unraid.net/unraid-os/manual/docker-management/). Replace it with the relative path (e.g., ../../manual/docker-management/) to adhere to internal linking conventions.
🤖 Prompt for AI Agents
In docs/unraid-os/getting-started/set-up-unraid/customize-unraid-settings.md
around lines 52 to 56, the link to the Docker Management page is an absolute
URL. Replace this absolute URL with a relative path such as
../../manual/docker-management/ to follow the internal linking conventions used
in the documentation.
| <div style={{ margin: 'auto', maxWidth: '700px'}}> | ||
|
|
||
|  | ||
| </div> | ||
|
|
There was a problem hiding this comment.
Relocate and update image references
The toolbar screenshot (/img/toolbar_settings.png) is missing from the build. Per the contributor checklist, place this image in an assets/ subfolder next to this doc and reference it relatively (e.g., ./assets/toolbar-settings.png).
🧰 Tools
🪛 LanguageTool
[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)
🤖 Prompt for AI Agents
In docs/unraid-os/getting-started/set-up-unraid/customize-unraid-settings.md
around lines 9 to 13, the image reference uses an absolute path
(/img/toolbar_settings.png) which causes the image to be missing from the build.
Move the toolbar screenshot image file into an assets/ subfolder located next to
this markdown file, rename it to toolbar-settings.png, and update the image
reference in the markdown to use a relative path like
./assets/toolbar-settings.png.
| <div style={{ maxWidth: '600px', margin: '1rem auto' }}> | ||
|
|
||
|  | ||
|
|
||
| </div> | ||
| In the image above, three drives contain streams of bits that vary by device size. These drives are unprotected, so if one fails, data will be lost. To protect against failure, we need a fourth disk as a parity disk, which must be equal to or larger than the largest data disk. |
There was a problem hiding this comment.
Relocate and update image references
The parity diagrams (/img/No_parity_500px.png, /img/Parity@500px.png, etc.) are missing and should be stored in an assets/ subfolder adjacent to this file. Update the markdown to reference ./assets/....
Also applies to: 42-46
🤖 Prompt for AI Agents
In docs/unraid-os/getting-started/what-is-unraid.md around lines 31 to 36 and
also lines 42 to 46, move the parity diagram images into a new assets/ folder
located next to this markdown file. Then update all image references in the
markdown from /img/filename.png to ./assets/filename.png to correctly point to
the new location.
|
|
||
| To use hardware virtualization in Unraid, ensure your CPU, chipset, BIOS, and device drivers are compatible. A full list of requirements is available <u>here</u>. If your server doesn't meet these requirements, the VMs menu will be disabled in the Unraid WebGUI. | ||
|
|
There was a problem hiding this comment.
Add missing hyperlink for requirements list
The text “a full list of requirements is available here” has no href. Please convert <u>here</u> into a proper markdown link pointing to the requirements page (e.g., [here](<relative-path-to-requirements>)).
🤖 Prompt for AI Agents
In docs/unraid-os/getting-started/what-is-unraid.md around lines 126 to 128, the
phrase "a full list of requirements is available <u>here</u>" uses an underlined
"here" without a hyperlink. Replace the underlined text with a proper markdown
link by changing "<u>here</u>" to "[here](<relative-path-to-requirements>)",
where <relative-path-to-requirements> is the correct relative path to the
requirements page within the documentation.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/docs-home.md (1)
14-14: Strengthen the closing message.Consider swapping “great” for a more impactful adjective to improve tone.
Apply this diff:- Also, there's a glossary term at the beginning so you can see what that functionality will look like. Have a great day! + Also, there's a glossary term at the beginning so you can see what that functionality will look like. Have a wonderful day!🧰 Tools
🪛 LanguageTool
[style] ~14-~14: Consider using a different adjective to strengthen your wording.
Context: ...t functionality will look like. Have a great day!(HAVE_A_NICE_DAY)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/docs-home.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/docs-home.md
[style] ~14-~14: Consider using a different adjective to strengthen your wording.
Context: ...t functionality will look like. Have a great day!
(HAVE_A_NICE_DAY)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: AWS Amplify Console Web Preview
🔇 Additional comments (2)
docs/docs-home.md (2)
8-8: Landing page header is clear and concise.The
# Hometitle appropriately denotes the primary landing page. No issues found.
10-10: Section title looks good.The
## Unraid Documentationsubtitle correctly introduces the documentation overview. 👍
|
This pull request is automatically being deployed by Amplify Hosting (learn more). |
This reverts commit d48e9fe.
Before Submitting This PR, Please Ensure You Have Completed The Following:
Summary by CodeRabbit