docs: Enhance cache pool expansion documentation and add cross-references #400
Conversation
… notification icons - Expand notification settings documentation with detailed configuration options: * Add comprehensive display/behavior settings, notification types, and delivery methods * Include step-by-step SMTP configuration with Gmail app password setup * Add detailed notification agent setup with icons for 13+ services (Discord, Slack, Telegram, etc.) - Significantly expand VM setup documentation with new Unraid 7.x features: * Add comprehensive VM snapshot management (create, revert, block commit/pull) * Include detailed troubleshooting sections and storage considerations * Expand GPU passthrough and PCI device binding documentation - Enhance system administration guides with detailed upgrade/downgrade procedures: * Add a comprehensive downgrade process via the Downgrade OS tool * Include post-downgrade verification and troubleshooting sections * Add warnings about ZFS compatibility and plugin issues - Add Creative Commons license information to the footer configuration - Include 20+ notification service icons (Discord, Slack, Telegram, Pushover, etc.) - Update Docker guide image and other visual assets
- Clarify WebGUI downgrade tool scope in upgrading-unraid.mdx - Fix broken snapshot link and list formatting in vm-setup.mdx - Correct Parity 2 technical description (Reed-Solomon Q-parity) in array-configuration.mdx - Fix compound adjective hyphenation (XFS‑formatted) - Remove redundant wording and incorrect "Sync" button reference in rebuild steps - Standardize formatting and cross-references in tailscale.mdx
Correct inaccurate "Memory dump" checkbox description - it's not preselected by default. Replace alarmist "permanent crash state" language with accurate explanation of memory-backed vs disk-only snapshots and their trade-offs.
- Fix inconsistent vDisk storage paths in VM conversion docs (use /mnt/user/ instead of /mnt/cache/) - Correct IDE vs SATA bus guidance to change both bus and dev attributes - Replace Force stop recommendation with safer Stop/normal shutdown guidance - Organize notification agent icons in dedicated static directory structure - Fix incorrect rebuild instruction (change "Sync" to "Start" button guidance)
Address critical feedback about content hidden behind tabbed/collapsible elements by reorganizing content as inline sections while maintaining clean layouts. **FAQ & Licensing FAQ:** - Improve anchor linking with heading structure (unique shareable links without cluttering TOC) - Flatten all questions for immediate accessibility - Verify all anchors work correctly **Array Configuration:** - Split monolithic 1,160+ line page into 5 focused pages: Overview, Adding disks, Replacing disks, Removing disks, Health & maintenance - Flatten content from tabs/expandables to inline sections - Retain version-specific tabs only - Update links and redirects for new structure **File Systems:** - Add Unraid 7.2 filesystem content (EXT4, NTFS, exFAT) - Add filesystem comparison table at top of page - Remove tab UI for filesystem introductions - Retain CLI-specific tabs for file system checks/repairs - Consolidate redundant partial files (btrfs/xfs/zfs intro, balance/scrub partials) - Add cross-reference link to ZFS storage page **Shares:** - Convert configurable option tabs to inline sections with descriptive headers - Move "Transferring files from network share" to CLI page (per feedback) - Retain version-specific tabs for 6.12+ vs 6.11 differences - Update links for new content location **Cache Pools:** - Remove tab UI, convert to inline sections - Delete "Backing up cache pool" section (redundant with move operations, per feedback) - Retain version-specific guidance as inline notes - Improve content flow with clear section headers **Unclean Shutdowns:** - Flatten tabbed VM configuration to inline sections - Expand Windows VM configuration with detailed step-by-step instructions - Add comprehensive timeout configuration tables - Enhance shutdown sequence explanations **Additional improvements:** - Improve CLI documentation with network file transfer section - Enhance VM setup documentation accessibility - Update Apple Time Machine style/formatting - Add ZFS storage cross-references - Apply CodeRabbit configuration file improvements - Reduce excessive bold text across pages for better visual hierarchy (maintain content substance)
- Changed import path for sidebar sorting utility from `sitebar-semver-sort.js` to `sidebar-semver-sort.js`. - Removed outdated `sitebar-semver-sort` TypeScript definition and JavaScript implementation. - Updated various documentation files for consistency, including fixing minor grammatical issues and improving formatting for better readability. - Adjusted links in the Docusaurus configuration to point to the new overview page for managing storage arrays.
- Changed the maximum heading level for the table of contents from 2 to 3 to improve navigation. - Removed the outdated index section to streamline the FAQ content and enhance readability.
…bility - Changed table of contents maximum heading level from 2 to 3 for better organization. - Removed outdated index sections from the FAQ to streamline content and enhance user experience. - Improved overall clarity and accessibility of the FAQ and Licensing FAQ sections.
- Removed outdated redirect entries in docusaurus.config.ts for clarity. - Enhanced API documentation with consistent formatting and improved readability across multiple files. - Updated CLI and API key management guides to reflect best practices and streamline user experience. - Improved overall structure and accessibility of various documentation sections, including OIDC provider setup and array management. - Minor editorial fixes and adjustments to ensure consistency in terminology and formatting.
- Updated redirect paths in docusaurus.config.ts to point to the new overview page for array management. - Improved API documentation formatting and consistency across multiple files. - Adjusted image paths in ZFS storage documentation to reference the correct assets folder. - Added markdown linting comments for better formatting in various Docker container management guides. - Removed outdated images related to ZFS storage to clean up the repository.
- Adjusted image paths in the ZFS storage documentation across multiple languages to reference the correct assets folder. - Ensured consistency in image references for better accessibility and organization of documentation.
- Corrected formatting of the eMMC support section in the release notes. - Ensured consistent use of backslashes in configuration options for clarity.
- Changed the tagline in docusaurus.config.ts for clarity. - Updated favicon path to use .ico format. - Ensured consistent use of backslashes in release notes for package versions.
- Standardized section headings for consistency across various settings pages. - Added detailed instructions for WiFi setup, including initial requirements and limitations. - Enhanced RAIDZ expansion documentation with step-by-step guidance and important notes. - Clarified BTRFS and ZFS pool management instructions, including adding disks and changing RAID levels. - Improved formatting and readability throughout the documentation for better user experience.
📝 WalkthroughWalkthroughRemoves the job-level if conditional from the deploy-preview GitHub Actions job, updates many documentation files (styling, headings, placeholders, image paths, new WiFi guide, notification agents, and content reflows), adds a client-side gtag stub, and updates docusaurus config (favicon, tagline, clientModules, redirect removal). Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: Repository UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🧰 Additional context used🧠 Learnings (1)📚 Learning: 2025-11-24T17:26:02.645ZApplied to files:
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
🔇 Additional comments (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/unraid-os/getting-started/set-up-unraid/customize-unraid-settings.mdx (1)
1-461: Critical mismatch between PR objectives and actual file changes.The PR title and description claim to enhance "cache pool expansion documentation" with changes to BTRFS, ZFS, and files like
cache-pools.mdx,zfs-storage.mdx, etc. However, this file (customize-unraid-settings.mdx) contains completely unrelated changes:
- WiFi setup documentation (lines 88-169)
- Notification settings expansion (lines 292-449)
- Heading case changes
This file has no connection to cache pools, BTRFS, or ZFS. Either:
- The wrong files are attached to this PR, or
- The PR objectives are incorrect and need updating
Please clarify whether this file should be part of this PR or if it belongs to a different PR.
🧹 Nitpick comments (8)
i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/using-unraid-to/run-docker-containers/partials/managing-and-customizing-containers/environment-variables.mdx (2)
5-5: Verify heading level change from h4 to h3.The conversion from HTML
<h4>tags to Markdown###(level 3) changes the semantic heading level in the document hierarchy. Confirm this adjustment is intentional and aligns with the document's overall structure.Also applies to: 12-12
23-23: Consider clearer placeholder format for API_KEY example.The placeholder
your_api_key_heremight not be obviously recognizable as a placeholder to all users. Consider using a more explicit format such as<your-api-key>,${YOUR_API_KEY}, orxxxxxxxxxxxxxxxxto make it clearer that this is not a literal value to use.docs/unraid-os/using-unraid-to/manage-storage/cache-pools.mdx (1)
133-133: Minor style improvement: Complete the sentence fragment.The phrase "Can be expanded one drive at a time" lacks a subject. Consider revising to "These pools can be expanded one drive at a time" for better readability.
🔎 Proposed fix
-- **Single-vdev RAIDZ1/2/3 pools:** A pool with one group of drives in a RAIDZ configuration. Can be expanded one drive at a time. See [RAIDZ expansion](#raidz-expansion) below. +- **Single-vdev RAIDZ1/2/3 pools:** A pool with one group of drives in a RAIDZ configuration. These pools can be expanded one drive at a time. See [RAIDZ expansion](#raidz-expansion) below.docs/unraid-os/troubleshooting/common-issues/unclean-shutdowns.mdx (1)
150-154: Consider removing blank lines for consistency.The note block has blank lines at lines 151 and 153 that aren't present in other note blocks throughout the file (e.g., lines 47-51, 61-65, 162-165). Removing these would maintain consistent formatting.
🔎 Proposed fix
:::note[Why appliance VMs are different] - Appliance %%VMs|vm%% are designed to run specific software and often don't allow the installation of additional packages, such as %%QEMU|qemu%% %%Guest Agent|guest-agent%%. This means hibernation isn't available, so you'll need to rely on proper timeout configuration. - :::docs/API/api-key-app-developer-authorization-flow.mdx (1)
50-50: Consider using bullet points for security considerations.The security requirements are consolidated into a single dense sentence. Security considerations are critical information that benefits from emphasis and scannability. Consider breaking this back into bullet points:
- Redirect URIs must use HTTPS (except localhost for development)
- Users explicitly approve each permission
- The flow uses existing Unraid authentication sessions
- API keys are shown once and must be saved securely
🔎 Proposed refactor
-Redirect URIs must use HTTPS (except localhost for development). Users explicitly approve each permission, and the flow uses existing Unraid authentication sessions. API keys are shown once and must be saved securely. +## Security considerations + +- Redirect URIs must use HTTPS (except localhost for development) +- Users explicitly approve each permission +- The flow uses existing Unraid authentication sessions +- API keys are shown once and must be saved securelydocs/API/how-to-use-the-api.mdx (1)
80-84: Document the placeholder syntax patterns for content authors.Two distinct placeholder patterns are used:
- Term references:
%%GraphQL|graphql%%(same text, different cases)- Link-style:
%%Array|array%%,%%parity checks|parity-check%%(display text | target)This dual-pattern usage should be documented in a content authoring guide to ensure consistency across contributors.
docs/API/cli.mdx (1)
193-193: Consider using bullet points for the notes section.Similar to the security considerations in the authorization flow doc, this consolidates multiple distinct points into a dense sentence. CLI reference documentation benefits from quick scannability.
🔎 Proposed refactor
-Most commands require appropriate permissions to modify system state. Some commands require the API to be running or stopped. Store API keys securely as they provide system access. %%SSO|sso%% configuration changes may require a service restart. +## Notes + +- Most commands require appropriate permissions to modify system state +- Some commands require the API to be running or stopped +- Store API keys securely as they provide system access +- %%SSO|sso%% configuration changes may require a service restartdocs/API/index.mdx (1)
33-33: Optional: Consider style refinements flagged by linter.Static analysis suggests:
- Line 33: "prior to" → "before" (shorter)
- Line 39: "gives" → "provides" (stronger verb)
These are minor style preferences. The current wording is clear and appropriate for user-facing documentation.
Also applies to: 39-39
📜 Review details
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (80)
docs/unraid-os/advanced-configurations/optimize-storage/assets/zfs1.pngis excluded by!**/*.pngdocs/unraid-os/advanced-configurations/optimize-storage/assets/zfs10.pngis excluded by!**/*.pngdocs/unraid-os/advanced-configurations/optimize-storage/assets/zfs11.pngis excluded by!**/*.pngdocs/unraid-os/advanced-configurations/optimize-storage/assets/zfs12.pngis excluded by!**/*.pngdocs/unraid-os/advanced-configurations/optimize-storage/assets/zfs13.pngis excluded by!**/*.pngdocs/unraid-os/advanced-configurations/optimize-storage/assets/zfs14.pngis excluded by!**/*.pngdocs/unraid-os/advanced-configurations/optimize-storage/assets/zfs15.pngis excluded by!**/*.pngdocs/unraid-os/advanced-configurations/optimize-storage/assets/zfs16.pngis excluded by!**/*.pngdocs/unraid-os/advanced-configurations/optimize-storage/assets/zfs2.pngis excluded by!**/*.pngdocs/unraid-os/advanced-configurations/optimize-storage/assets/zfs3.pngis excluded by!**/*.pngdocs/unraid-os/advanced-configurations/optimize-storage/assets/zfs4.pngis excluded by!**/*.pngdocs/unraid-os/advanced-configurations/optimize-storage/assets/zfs5.pngis excluded by!**/*.pngdocs/unraid-os/advanced-configurations/optimize-storage/assets/zfs6.pngis excluded by!**/*.pngdocs/unraid-os/advanced-configurations/optimize-storage/assets/zfs7.pngis excluded by!**/*.pngdocs/unraid-os/advanced-configurations/optimize-storage/assets/zfs8.pngis excluded by!**/*.pngdocs/unraid-os/advanced-configurations/optimize-storage/assets/zfs9.pngis excluded by!**/*.pngi18n/de/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs1.pngis excluded by!**/*.pngi18n/de/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs10.pngis excluded by!**/*.pngi18n/de/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs11.pngis excluded by!**/*.pngi18n/de/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs12.pngis excluded by!**/*.pngi18n/de/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs13.pngis excluded by!**/*.pngi18n/de/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs14.pngis excluded by!**/*.pngi18n/de/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs15.pngis excluded by!**/*.pngi18n/de/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs16.pngis excluded by!**/*.pngi18n/de/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs2.pngis excluded by!**/*.pngi18n/de/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs3.pngis excluded by!**/*.pngi18n/de/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs4.pngis excluded by!**/*.pngi18n/de/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs5.pngis excluded by!**/*.pngi18n/de/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs6.pngis excluded by!**/*.pngi18n/de/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs7.pngis excluded by!**/*.pngi18n/de/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs8.pngis excluded by!**/*.pngi18n/de/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs9.pngis excluded by!**/*.pngi18n/es/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs1.pngis excluded by!**/*.pngi18n/es/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs10.pngis excluded by!**/*.pngi18n/es/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs11.pngis excluded by!**/*.pngi18n/es/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs12.pngis excluded by!**/*.pngi18n/es/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs13.pngis excluded by!**/*.pngi18n/es/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs14.pngis excluded by!**/*.pngi18n/es/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs15.pngis excluded by!**/*.pngi18n/es/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs16.pngis excluded by!**/*.pngi18n/es/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs2.pngis excluded by!**/*.pngi18n/es/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs3.pngis excluded by!**/*.pngi18n/es/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs4.pngis excluded by!**/*.pngi18n/es/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs5.pngis excluded by!**/*.pngi18n/es/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs6.pngis excluded by!**/*.pngi18n/es/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs7.pngis excluded by!**/*.pngi18n/es/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs8.pngis excluded by!**/*.pngi18n/es/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs9.pngis excluded by!**/*.pngi18n/fr/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs1.pngis excluded by!**/*.pngi18n/fr/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs10.pngis excluded by!**/*.pngi18n/fr/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs11.pngis excluded by!**/*.pngi18n/fr/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs12.pngis excluded by!**/*.pngi18n/fr/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs13.pngis excluded by!**/*.pngi18n/fr/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs14.pngis excluded by!**/*.pngi18n/fr/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs15.pngis excluded by!**/*.pngi18n/fr/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs16.pngis excluded by!**/*.pngi18n/fr/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs2.pngis excluded by!**/*.pngi18n/fr/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs3.pngis excluded by!**/*.pngi18n/fr/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs4.pngis excluded by!**/*.pngi18n/fr/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs5.pngis excluded by!**/*.pngi18n/fr/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs6.pngis excluded by!**/*.pngi18n/fr/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs7.pngis excluded by!**/*.pngi18n/fr/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs8.pngis excluded by!**/*.pngi18n/fr/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs9.pngis excluded by!**/*.pngi18n/zh/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs1.pngis excluded by!**/*.pngi18n/zh/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs10.pngis excluded by!**/*.pngi18n/zh/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs11.pngis excluded by!**/*.pngi18n/zh/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs12.pngis excluded by!**/*.pngi18n/zh/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs13.pngis excluded by!**/*.pngi18n/zh/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs14.pngis excluded by!**/*.pngi18n/zh/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs15.pngis excluded by!**/*.pngi18n/zh/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs16.pngis excluded by!**/*.pngi18n/zh/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs2.pngis excluded by!**/*.pngi18n/zh/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs3.pngis excluded by!**/*.pngi18n/zh/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs4.pngis excluded by!**/*.pngi18n/zh/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs5.pngis excluded by!**/*.pngi18n/zh/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs6.pngis excluded by!**/*.pngi18n/zh/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs7.pngis excluded by!**/*.pngi18n/zh/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs8.pngis excluded by!**/*.pngi18n/zh/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/assets/zfs9.pngis excluded by!**/*.png
📒 Files selected for processing (43)
.github/workflows/pr.yml(0 hunks)docs/API/api-key-app-developer-authorization-flow.mdx(3 hunks)docs/API/cli.mdx(10 hunks)docs/API/how-to-use-the-api.mdx(7 hunks)docs/API/index.mdx(2 hunks)docs/API/oidc-provider-setup.mdx(10 hunks)docs/API/partials/get-started-pre72.mdx(1 hunks)docs/API/partials/get-started-v72.mdx(1 hunks)docs/API/partials/manage-api-keys-gui.mdx(1 hunks)docs/API/programmatic-api-key-management.mdx(8 hunks)docs/API/upcoming-features.mdx(1 hunks)docs/unraid-account/server-management.mdx(2 hunks)docs/unraid-os/advanced-configurations/optimize-storage/zfs-storage.mdx(15 hunks)docs/unraid-os/getting-started/set-up-unraid/customize-unraid-settings.mdx(8 hunks)docs/unraid-os/release-notes/7.2.0.md(6 hunks)docs/unraid-os/system-administration/advanced-tools/command-line-interface.mdx(20 hunks)docs/unraid-os/system-administration/maintain-and-update/upgrading-unraid.mdx(1 hunks)docs/unraid-os/troubleshooting/common-issues/unclean-shutdowns.mdx(10 hunks)docs/unraid-os/troubleshooting/faq.mdx(16 hunks)docs/unraid-os/troubleshooting/licensing-faq.mdx(1 hunks)docs/unraid-os/using-unraid-to/create-virtual-machines/vm-setup.mdx(8 hunks)docs/unraid-os/using-unraid-to/manage-storage/array/adding-disks-to-array.mdx(3 hunks)docs/unraid-os/using-unraid-to/manage-storage/array/array-health-and-maintenance.mdx(5 hunks)docs/unraid-os/using-unraid-to/manage-storage/array/overview.mdx(3 hunks)docs/unraid-os/using-unraid-to/manage-storage/array/removing-disks-from-array.mdx(2 hunks)docs/unraid-os/using-unraid-to/manage-storage/array/replacing-disks-in-array.mdx(6 hunks)docs/unraid-os/using-unraid-to/manage-storage/cache-pools.mdx(3 hunks)docs/unraid-os/using-unraid-to/manage-storage/file-systems.mdx(1 hunks)docusaurus.config.ts(1 hunks)i18n/de/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/zfs-storage.mdx(12 hunks)i18n/es/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/zfs-storage.mdx(12 hunks)i18n/fr/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/zfs-storage.mdx(12 hunks)i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/zfs-storage.mdx(12 hunks)i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/using-unraid-to/run-docker-containers/partials/managing-and-customizing-containers/command-logs.mdx(1 hunks)i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/using-unraid-to/run-docker-containers/partials/managing-and-customizing-containers/command-restart.mdx(1 hunks)i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/using-unraid-to/run-docker-containers/partials/managing-and-customizing-containers/command-start.mdx(1 hunks)i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/using-unraid-to/run-docker-containers/partials/managing-and-customizing-containers/command-status.mdx(1 hunks)i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/using-unraid-to/run-docker-containers/partials/managing-and-customizing-containers/command-stop.mdx(1 hunks)i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/using-unraid-to/run-docker-containers/partials/managing-and-customizing-containers/environment-variables.mdx(1 hunks)i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/using-unraid-to/run-docker-containers/partials/managing-and-customizing-containers/network-type.mdx(1 hunks)i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/using-unraid-to/run-docker-containers/partials/managing-and-customizing-containers/port-mappings.mdx(1 hunks)i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/using-unraid-to/run-docker-containers/partials/managing-and-customizing-containers/volume-mappings.mdx(1 hunks)src/clientModules/gtag-stub.js(1 hunks)
💤 Files with no reviewable changes (1)
- .github/workflows/pr.yml
🧰 Additional context used
🧠 Learnings (6)
📚 Learning: 2025-11-24T17:26:02.645Z
Learnt from: ljm42
Repo: unraid/docs PR: 394
File: docs/unraid-os/troubleshooting/licensing-faq.mdx:135-140
Timestamp: 2025-11-24T17:26:02.645Z
Learning: As of Unraid 7.2.1, the maximum devices per pool limit for Unleashed and Lifetime licenses is 200 (increased from previous limits of 60 in 6.12 and 120 in later versions).
Applied to files:
i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/zfs-storage.mdxdocs/unraid-os/troubleshooting/licensing-faq.mdxdocs/unraid-os/troubleshooting/faq.mdxi18n/de/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/zfs-storage.mdxdocs/unraid-os/release-notes/7.2.0.mddocs/unraid-os/advanced-configurations/optimize-storage/zfs-storage.mdxdocs/unraid-os/using-unraid-to/manage-storage/cache-pools.mdx
📚 Learning: 2025-09-28T04:47:45.534Z
Learnt from: elibosley
Repo: unraid/docs PR: 339
File: docs/unraid-os/getting-started/what-is-unraid.mdx:64-80
Timestamp: 2025-09-28T04:47:45.534Z
Learning: In Docusaurus MDX files, `mdx-code-block` is not a literal code block but an escape hatch for Crowdin translation integration. It's a no-op wrapper that allows complex JSX to be preserved during Crowdin upload/download cycles while still rendering normally. Docusaurus includes special handling that unwraps these blocks so the JSX content renders as intended.
Applied to files:
i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/using-unraid-to/run-docker-containers/partials/managing-and-customizing-containers/port-mappings.mdx
📚 Learning: 2025-09-17T16:28:59.403Z
Learnt from: elibosley
Repo: unraid/docs PR: 325
File: docs/unraid-os/system-administration/maintain-and-update/changing-the-flash-device.mdx:123-131
Timestamp: 2025-09-17T16:28:59.403Z
Learning: Unraid's flash backup feature (accessed via Main tab → Flash device → FLASH BACKUP) creates complete installation ZIP files that include both the Unraid OS and user configuration. These backup ZIPs are compatible with the USB Flash Creator's "Use custom" option for restoring to new flash devices.
Applied to files:
docs/unraid-os/troubleshooting/licensing-faq.mdxdocs/unraid-os/troubleshooting/faq.mdxdocs/unraid-os/release-notes/7.2.0.mddocs/unraid-os/advanced-configurations/optimize-storage/zfs-storage.mdx
📚 Learning: 2025-05-23T16:04:50.060Z
Learnt from: expliyh
Repo: unraid/docs PR: 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.
Applied to files:
docs/unraid-os/troubleshooting/faq.mdx
📚 Learning: 2025-05-23T16:04:50.060Z
Learnt from: expliyh
Repo: unraid/docs PR: 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.
Applied to files:
docs/unraid-os/troubleshooting/faq.mdx
📚 Learning: 2025-05-23T16:28:30.374Z
Learnt from: expliyh
Repo: unraid/docs PR: 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"以保持与实际用户界面的一致性。
Applied to files:
i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/using-unraid-to/run-docker-containers/partials/managing-and-customizing-containers/command-start.mdx
🪛 LanguageTool
i18n/fr/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/zfs-storage.mdx
[style] ~83-~83: Une modification de la structure de la négation apportera de la légèreté et de la précision à cette phrase.
Context: ...es disques au pool (l'ordre des disques n'a pas d'importance). <div style={{ margin: 'aut...
(NEGATION_AVOIR)
[typographical] ~89-~89: Caractère d’apostrophe incorrect.
Context: ...liquez sur le nom du pool (par exemple, raptor) pour ouvrir son écran de configuration...
(APOS_INCORRECT)
[typographical] ~140-~140: Caractère d’apostrophe incorrect.
Context: ...tème de fichiers**, choisissez zfs ou zfs-encrypted. <div style={{ margin: 'auto', maxWidt...
(APOS_INCORRECT)
docs/unraid-os/using-unraid-to/manage-storage/array/array-health-and-maintenance.mdx
[style] ~152-~152: Consider using a different verb for a more formal wording.
Context: ...art, follow these steps to identify and fix common problems. Look for error message...
(FIX_RESOLVE)
docs/unraid-os/using-unraid-to/manage-storage/array/replacing-disks-in-array.mdx
[style] ~225-~225: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...sabled. If the drive is healthy but you want to replace it, unassign the drive and star...
(REP_WANT_TO_VB)
[style] ~226-~226: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... force Unraid to mark it as disabled. - If your replacement data drive is not larg...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
docs/API/oidc-provider-setup.mdx
[style] ~59-~59: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... have a small list of specific users. - You're new to OIDC configuration. <details...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~75-~75: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...., email domain AND verified status). - You have complex authorization requirements...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~76-~76: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...e complex authorization requirements. - You need fine-grained control over how rule...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
docs/unraid-os/release-notes/7.2.0.md
[style] ~173-~173: Consider using the internationally preferred transliteration for the capital of Ukraine.
Context: ...ireGuard tunnels - Improvement: Europe/Kiev timezone renamed to Europe/Kyiv to a...
(KIEV)
docs/unraid-os/advanced-configurations/optimize-storage/zfs-storage.mdx
[style] ~96-~96: 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)
docs/API/index.mdx
[style] ~33-~33: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...nd Advanced Users) For Unraid versions prior to 7.2, or to access newer API features: ...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[style] ~39-~39: Try using a synonym here to strengthen your writing.
Context: ...y. Installing the plugin on Unraid 7.2+ gives you access to newer API features before the...
(GIVE_PROVIDE)
docs/unraid-os/troubleshooting/common-issues/unclean-shutdowns.mdx
[style] ~181-~181: Try using a synonym here to strengthen your writing.
Context: ... if you have multiple %%VMs|vm%%). This gives services more time to shut down gracefu...
(GIVE_PROVIDE)
docs/unraid-os/using-unraid-to/manage-storage/cache-pools.mdx
[style] ~133-~133: To form a complete sentence, be sure to include a subject.
Context: ...oup of drives in a RAIDZ configuration. Can be expanded one drive at a time. See [R...
(MISSING_IT_THERE)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: deploy-preview
🔇 Additional comments (63)
i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/using-unraid-to/run-docker-containers/partials/managing-and-customizing-containers/network-type.mdx (2)
1-2:⚠️ Inconsistency: File scope doesn't match PR objectives.The PR objectives describe enhancements to cache pool documentation (BTRFS/ZFS), but this file is about Docker network configuration in Chinese. The file and stated objectives appear misaligned—please verify this file is intended to be part of this PR.
1-2: Markdownlint directive is appropriately applied.The
markdownlint-disable MD041directive is correct for a partial file that begins with content rather than a heading, consistent with similar partials in the same directory structure.docs/unraid-account/server-management.mdx (2)
6-10: Inconsistency: This file doesn't match the PR objectives.The PR objectives state this PR is about "Enhance cache pool expansion documentation and add cross-references" for BTRFS pools, ZFS pools, cache-pools.mdx, zfs-storage.mdx, etc. However, this file (server-management.mdx) is about server management in the Unraid account app and has nothing to do with cache pools.
The wording change itself (removing "OS" and "v") is fine and makes the text more concise.
24-30: Documentation correctly updated for new removal option.The count is properly updated from "two" to "three" and the new third option is clearly documented. The changes are accurate and improve the documentation.
However, this still doesn't align with the PR objectives about cache pool expansion documentation.
docs/unraid-os/troubleshooting/licensing-faq.mdx (1)
98-101: Inconsistency between PR objectives and file content.The PR objectives describe enhancements to cache pool expansion documentation, but this file (
licensing-faq.mdx) contains licensing information unrelated to cache pools. The AI summary mentions "broader formatting and linting changes across documentation," suggesting this PR may contain multiple unrelated changes.The technical implementation of the markdownlint suppression is correct and follows best practices for handling HTML elements in Markdown when native Markdown syntax is insufficient.
i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/using-unraid-to/run-docker-containers/partials/managing-and-customizing-containers/environment-variables.mdx (4)
1-31: Verify PR scope: file changes don't match stated objectives.The PR objectives describe enhancements to cache pool expansion documentation (BTRFS Balance operations, ZFS pool types, cross-references to cache-pools.mdx, zfs-storage.mdx, etc.), but this file contains changes to Docker environment variables documentation in Chinese. There's no apparent connection between the stated objectives and this file.
Please confirm whether:
- This file was included in the PR by mistake, or
- The PR objectives/description need updating to reflect the actual scope
1-2: LGTM: Appropriate linting exception for partial file.Disabling MD041 is correct for partial Markdown files that don't require a top-level heading, as they're typically included within other documents.
18-18: LGTM: Improved localization consistency.Converting the mixed English-Chinese label to pure Chinese ("环境变量示例") is appropriate for a Chinese translation file and follows better localization practices.
27-31: LGTM: Good security guidance.The updated tip effectively emphasizes security best practices by advising against hardcoding sensitive information, which enhances both container portability and security.
docs/unraid-os/using-unraid-to/manage-storage/file-systems.mdx (1)
101-101: LGTM! Cross-reference enhances navigation.The added cross-reference to the BTRFS pools section provides helpful navigation for users wanting to learn more about expanding BTRFS pools. This aligns well with the PR's objective of improving discoverability.
docs/unraid-os/using-unraid-to/manage-storage/cache-pools.mdx (4)
84-84: Helpful internal cross-reference added.The cross-reference to the detailed "Adding disks to a pool" section improves document navigation and helps users find relevant instructions quickly.
113-128: Excellent addition explaining BTRFS pool expansion.The new BTRFS pools section provides clear step-by-step instructions and includes valuable context about the automatic Balance operation. The timing expectations and monitoring guidance help users understand what to expect during the expansion process.
143-167: Excellent guidance on ZFS pool expansion planning and execution.The planning tip for two-device pools is particularly valuable, helping users make informed decisions during initial setup. The RAIDZ expansion instructions are comprehensive and include important warnings about pool upgrades and version compatibility.
184-184: Good internal cross-reference for related content.The cross-reference to the BTRFS pools section effectively connects related information within the document, improving navigation for users working with BTRFS pools.
docs/unraid-os/troubleshooting/common-issues/unclean-shutdowns.mdx (1)
6-6: LGTM - Formatting improvements enhance consistency.The formatting changes improve consistency throughout the documentation:
- Settings paths now use a uniform
**_Settings → ..._**format- Markdownlint suppressions are appropriately applied for MD041 and MD046
- Code block formatting is standardized
These presentational changes enhance readability without altering the content or instructions.
Also applies to: 21-21, 31-31, 175-177, 205-208, 226-226, 255-255, 274-274, 302-305
docs/unraid-os/getting-started/set-up-unraid/customize-unraid-settings.mdx (4)
340-408: LGTM! Excellent SMTP and Gmail configuration documentation.The SMTP settings section, especially the Gmail app password configuration, is comprehensive and accurate. The step-by-step instructions, security recommendations, and port information are all correct. This will be very helpful for users setting up email notifications.
22-456: Heading case changes are consistent with documentation style guide.The headings have been appropriately changed from Title Case to sentence case, which aligns with the Unraid documentation standards.
418-430: All notification agent icon files are present. No issues found.
88-169: Verify ipvlan/macvlan WiFi support claim with Unraid developers.The review's verification requests are mostly accurate:
- WPA3 automatic preference is confirmed by official Unraid 7.1.0 documentation.
- GitHub USB WiFi adapter list is actively maintained and accessible.
- WiFi limitations and Docker/VM considerations appear well-documented.
However, the claim that "macvlan is not supported with WiFi" (line 155) could not be verified through available Unraid documentation. Search results show general macvlan stability issues in Unraid Docker, but no WiFi-specific restriction. Confirm whether this is a WiFi-specific constraint or a general Docker configuration matter before finalizing this section.
docs/API/upcoming-features.mdx (1)
7-8: LGTM! Appropriate markdownlint configuration.Disabling MD024 is appropriate here since the roadmap legitimately uses duplicate headings like "Completed Features ✅" and "Planned Features 📅" under different parent sections.
i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/using-unraid-to/run-docker-containers/partials/managing-and-customizing-containers/command-restart.mdx (2)
1-2: LGTM! Correct markdownlint configuration for partial files.Disabling MD041 is appropriate for partial MDX files that are imported into other documents, as they shouldn't require a top-level heading.
5-7: LGTM! Enhanced syntax highlighting.Adding the
bashlanguage identifier to the code fence improves syntax highlighting for readers.docs/unraid-os/system-administration/maintain-and-update/upgrading-unraid.mdx (1)
6-7: LGTM! Appropriate markdownlint configuration for MDX with JSX.Disabling MD041 and MD033 is correct for Docusaurus MDX files that:
- Start with YAML frontmatter and imports before the first heading (MD041)
- Use JSX components like
<Tabs>and custom HTML elements (MD033)i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/using-unraid-to/run-docker-containers/partials/managing-and-customizing-containers/command-stop.mdx (1)
1-7: LGTM! Consistent formatting improvements.The changes align with best practices:
- MD041 disable is appropriate for partial MDX files
- Adding
bashsyntax improves code highlightingsrc/clientModules/gtag-stub.js (2)
1-8: LGTM! Standard gtag stub implementation.The implementation follows the standard pattern for gtag stubs. Pushing the
argumentsobject directly todataLayeris correct—this is how Google Analytics' official gtag stub works.
1-8: Critical: Incorrectargumentshandling in gtag stub.Line 5 pushes the
argumentsobject directly todataLayer, but this won't work correctly. Theargumentsobject is array-like but not a true array, and gtag expects individual arguments to be pushed.🔎 Proposed fix
if (typeof window !== 'undefined') { window.dataLayer = window.dataLayer || []; if (typeof window.gtag !== 'function') { - window.gtag = function gtagStub() { - window.dataLayer.push(arguments); + window.gtag = function gtag() { + window.dataLayer.push(arguments); }; } }Wait, I need to reconsider. Looking at the official gtag documentation, the standard pattern for gtag stubs is:
window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);}So pushing
argumentsdirectly is actually the correct pattern! The dataLayer is designed to handle the arguments object. Let me revise my assessment.Actually, upon further review, this IS the correct implementation pattern for gtag stubs. The dataLayer.push(arguments) is the standard approach used by Google Analytics.
Actually, I need to correct my assessment. After reviewing the standard gtag stub pattern, pushing
argumentsdirectly todataLayeris the correct implementation. This is the standard pattern used by Google Analytics.i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/using-unraid-to/run-docker-containers/partials/managing-and-customizing-containers/port-mappings.mdx (1)
1-2: LGTM! Appropriate configuration for partial files.MD041 disable is correct for partial MDX files that don't require top-level headings.
i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/using-unraid-to/run-docker-containers/partials/managing-and-customizing-containers/command-logs.mdx (1)
1-7: LGTM! Consistent with other command documentation.The changes follow the same pattern as other Docker command partials—appropriate MD041 disable and improved bash syntax highlighting.
docs/API/partials/manage-api-keys-gui.mdx (1)
1-8: LGTM! Formatting and placeholder improvements.The changes improve consistency:
- MD041 disable is appropriate for partial files
- The
%%WebGUI|web-gui%%placeholder follows the established pattern for glossary terms- Adding trailing periods to bullet points improves consistency
docs/unraid-os/release-notes/7.2.0.md (6)
50-50: LGTM!Formatting update for the navigation path is consistent with the rest of the document.
62-62: LGTM!Navigation path formatting updated consistently.
92-92: LGTM!Navigation path formatting updated consistently.
138-140: LGTM!Formatting updates for navigation paths and italicized terms are consistent.
171-173: LGTM!The static analysis hint about "Kiev" is a false positive—the text correctly documents the renaming from
Europe/KievtoEurope/Kyiv, which aligns with the IANA Time Zone Database change.
32-37: Incorrect link target in RAIDZ expansion reference.The cross-reference link points to
cache-pools.mdx#raidz-expansion, but RAIDZ expansion is documented in the ZFS storage page, not the cache pools page. Update the link to reference the ZFS storage documentation instead, where detailed RAIDZ expansion guidance is properly located.Likely an incorrect or invalid review comment.
docs/unraid-os/using-unraid-to/manage-storage/array/removing-disks-from-array.mdx (2)
6-6: LGTM!Minor whitespace adjustment after frontmatter is fine.
67-78: LGTM!The whitespace adjustments in the parity-preserve method steps maintain readability. The instruction to replace
Xwith the disk number is clear and helpful.docs/unraid-os/using-unraid-to/manage-storage/array/array-health-and-maintenance.mdx (5)
20-20: LGTM!Navigation path formatting standardized to Array Operations.
35-35: LGTM!Navigation path formatting standardized to Settings → Scheduler.
47-47: LGTM!Navigation path formatting standardized to Array Operations.
152-152: LGTM!Navigation path formatting standardized. The static analysis suggestion to use "resolve" instead of "fix" is purely stylistic—"fix" is clear and appropriate for user-facing documentation.
202-202: LGTM!Trailing newline added for consistent file formatting.
docs/unraid-os/using-unraid-to/manage-storage/array/adding-disks-to-array.mdx (3)
24-24: LGTM!Navigation path formatting standardized to Main → Array Devices.
40-51: Good conversion from HTML to Markdown table.Replacing the flexbox-styled HTML table with a standard Markdown table improves maintainability and source readability. The table structure and content are clear.
123-123: LGTM!The emphasis change from bold to italics for parity bit is appropriate for introducing a technical term.
docs/unraid-os/advanced-configurations/optimize-storage/zfs-storage.mdx (6)
6-7: LGTM!Adding the markdownlint disable comment for MD041 (first line heading) is appropriate given the import statements that follow.
80-131: LGTM!The markdownlint disable comments for MD029 (ordered list numbering) are appropriately placed to allow the numbered steps to continue across the interspersed image blocks. This maintains proper step numbering for user readability while satisfying linting requirements.
182-188: LGTM!Minor table alignment adjustments for consistency.
298-301: LGTM!Markdownlint disable comments for MD007 (list indentation) appropriately placed for the nested list items within the details block.
391-391: Content update with validated cross-reference.This clarifies RAIDZ expansion availability in the WebGUI (Unraid 7.2+) and adds a helpful cross-reference to the detailed expansion documentation in cache-pools.mdx. The anchor
#raidz-expansionexists and is correctly referenced.
44-44: Image path updated to relative asset reference.The change to
./assets/zfs1.pngfollows a consistent pattern throughout the file, with all 16 image references using the same relative path structure. Asset files are confirmed to exist at the expected location.docs/unraid-os/using-unraid-to/manage-storage/array/overview.mdx (1)
173-173: Good addition of RAIDZ expansion cross-reference.This cross-reference aligns well with the PR objectives to enhance cache pool expansion documentation and improve discoverability of related information.
i18n/fr/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/zfs-storage.mdx (1)
40-40: LGTM! Image path migration is consistent.All image references have been correctly updated from absolute paths (
/img/zfsX.png) to relative asset paths (./assets/zfsX.png). This improves maintainability and aligns with the project's asset organization strategy.Also applies to: 56-56, 69-69, 80-80, 86-86, 93-93, 103-103, 107-107, 137-137, 143-143, 156-156, 182-182, 208-208, 223-223, 259-259, 270-270
i18n/de/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/zfs-storage.mdx (1)
40-40: LGTM! Asset path updates are correct.All image references successfully migrated to the relative asset path structure. The changes maintain consistency across all language variants.
Also applies to: 56-56, 69-69, 80-80, 86-86, 93-93, 103-103, 107-107, 135-135, 141-141, 154-154, 178-178, 204-204, 219-219, 255-255, 266-266
i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/using-unraid-to/run-docker-containers/partials/managing-and-customizing-containers/command-status.mdx (1)
1-2: LGTM! Good formatting improvements.Adding the markdownlint directive and bash syntax highlighting enhances code presentation without changing functionality.
Also applies to: 5-7
i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/using-unraid-to/run-docker-containers/partials/managing-and-customizing-containers/command-start.mdx (1)
1-2: LGTM! Helpful clarification added.The markdownlint directive and bash syntax highlighting are appropriate. The added instruction about replacing the placeholder with the actual container name improves clarity for Chinese readers.
Also applies to: 5-7, 9-9
i18n/es/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/zfs-storage.mdx (1)
40-40: LGTM! Asset paths updated consistently.Image references correctly migrated to relative paths, matching the pattern across all localization files.
Also applies to: 56-56, 69-69, 80-80, 86-86, 93-93, 103-103, 107-107, 135-135, 141-141, 154-154, 178-178, 204-204, 219-219, 255-255, 266-266
i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/zfs-storage.mdx (1)
40-40: Asset path migration looks good.The image references have been correctly updated to relative paths, consistent with other localization files.
Also applies to: 56-56, 69-69, 80-80, 86-86, 93-93, 103-103, 107-107, 154-154, 178-178, 204-204, 219-219, 255-255, 266-266
docs/API/partials/get-started-pre72.mdx (1)
1-7: LGTM! Documentation improvements enhance navigation.The addition of hyperlinks to related documentation and the use of the
%%GraphQL|graphql%%macro improve consistency and user experience. Formatting adjustments improve readability.i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/using-unraid-to/run-docker-containers/partials/managing-and-customizing-containers/volume-mappings.mdx (1)
1-2: LGTM! Formatting improvements enhance readability.The markdownlint directive, additional spacing, and quote standardization improve the document's presentation without changing its meaning.
Also applies to: 9-13, 19-19
docs/API/index.mdx (1)
35-37: All cross-reference link targets verified and exist:
../unraid-connect/overview-and-setup.mdx✓../unraid-os/using-unraid-to/run-docker-containers/community-applications.mdx✓./how-to-use-the-api.mdx#enabling-the-graphql-sandbox✓docs/API/how-to-use-the-api.mdx (1)
82-82: Cross-reference link verified successfully.The target file
docs/unraid-os/using-unraid-to/manage-storage/array/overview.mdxexists and contains theparity-checkanchor at lines 77, 92, and 158. The link is valid.docs/API/partials/get-started-v72.mdx (1)
5-7: The placeholder templating system is properly configured and will correctly process these tokens. TheremarkAutoGlossaryplugin is installed, configured indocusaurus.config.ts, and theglossary.yamlfile contains the GraphQL entry. No action needed.Likely an incorrect or invalid review comment.
...ugin-content-docs/current/unraid-os/advanced-configurations/optimize-storage/zfs-storage.mdx
Show resolved
Hide resolved
- Replaced outdated image reference in the ZFS storage documentation with a new image for improved clarity and accuracy.
|
2 participants
This PR enhances the cache pool documentation with user-friendly clarifications and improves navigation through strategic cross-referencing.
Enhancements to cache pool expansion section
BTRFS pools:
ZFS pools:
Cross-references:
These changes address client feedback and improve documentation clarity for users of all skill levels by explaining technical concepts in accessible language and improving discoverability of related information.
Summary by CodeRabbit
New Features
Documentation
Chores
✏️ Tip: You can customize this high-level summary in your review settings.