chore: fix admonition markdown #335
Conversation
📝 WalkthroughWalkthroughStandardizes MDX admonition syntax across many documentation pages by converting inline admonition titles to bracketed forms (e.g., :::tip[...]). A small number of pages include minor content additions (extra bullets/steps) or a capitalization/formatting tweak. No code, API, or control-flow changes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (3)
🚧 Files skipped from review as they are similar to previous changes (3)
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: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (7)
docs/unraid-os/using-unraid-to/run-docker-containers/managing-and-customizing-containers.mdx (1)
352-354: Fix typo in docker logs example (missing closing quote).The command shows an unmatched quote which may confuse users.
Apply this diff:
- docker logs "container-name + docker logs "container-name"docs/unraid-os/system-administration/maintain-and-update/upgrading-unraid.mdx (1)
63-71: Polish punctuation and complete sentence in ZFS warning.Minor readability fixes.
Apply this diff:
-When upgrading to Unraid 7.x, you may see warnings about [%%ZFS|zfs%%](../../advanced-configurations/optimize-storage/zfs-storage.mdx) pool feature upgrades during boot or in the %%WebGUI|web-gui%%. These warnings are not a sign of a problem; they simply indicate that your %%ZFS|zfs%% pool is using features from an older version +When upgrading to Unraid 7.x, you may see warnings about [%%ZFS|zfs%%](../../advanced-configurations/optimize-storage/zfs-storage.mdx) pool feature upgrades during boot or in the %%WebGUI|web-gui%%. These warnings are not a sign of a problem; they simply indicate that your %%ZFS|zfs%% pool is using features from an older version of ZFS. -Upgrading your pool isn't urgent, but if you do decide to upgrade, keep in mind that it may not work with previous versions of Unraid. This means you may not be able to revert to a previous Unraid version after making the upgrade. +Upgrading your pool isn't urgent, but if you do decide to upgrade, keep in mind that it may not work with previous versions of Unraid. This means you may not be able to revert to a previous Unraid version after making the upgrade. -As always, remember to back up your data before upgrading your %%ZFS|zfs%% pools +As always, remember to back up your data before upgrading your %%ZFS|zfs%% pools.docs/unraid-os/using-unraid-to/manage-storage/cache-pools.mdx (1)
503-507: Fix grammar in “Remember” note.Minor copy edit for clarity.
Apply this diff:
-Any the files belong to a Docker container and/or %%VM|vm%% then the services must be disabled for the files to be moved successfully. +If any of the files belong to a Docker container and/or %%VM|vm%%, the services must be disabled for the files to be moved successfully.docs/unraid-os/using-unraid-to/create-virtual-machines/vm-setup.mdx (1)
10-21: Admonition title conversions are solid.One copy nit:
-- **Flexibility:** Transform your unraid server into a multi-purpose workstation. +- **Flexibility:** Transform your Unraid server into a multi-purpose workstation.Also applies to: 29-35, 87-93, 215-221, 264-270
docs/unraid-os/using-unraid-to/manage-storage/array-configuration.mdx (3)
637-643: Typo in link macro breaks formatting.Trailing percent is missing in the link macro.
- - Always verify the health of all drives using %%SMART reports|smart-report%% before starting a %%parity swap|parity-swap%. + - Always verify the health of all drives using %%SMART reports|smart-report%% before starting a %%parity swap|parity-swap%%.
1045-1050: Admonition not closed correctly (syntax error).There’s “::::” instead of “:::” which will break MDX parsing.
-:::caution +:::caution ... -:::: +:::
1311-1317: License tier name misspelled.Should be “Unleashed”.
- - **Paid License:** This is yours to keep forever! However, there are limits on the number of devices based on the plan you choose (**Starter**, **Unleased**, or **Lifetime**). After you activate it, you don't have to connect to the internet anymore. + - **Paid License:** This is yours to keep forever! However, there are limits on the number of devices based on the plan you choose (**Starter**, **Unleashed**, or **Lifetime**). After you activate it, you don't have to connect to the internet anymore.
🧹 Nitpick comments (6)
docs/unraid-connect/remote-access.mdx (1)
13-18: LGTM on bracketed title; consider aligning the Troubleshooting block too.Optional: Convert later inline title to bracket form for consistency:
- Line 117:
:::caution **Troubleshooting**→:::caution[Troubleshooting]docs/unraid-os/using-unraid-to/manage-storage/shares.mdx (1)
59-63: Consider using “danger” for truly critical guidance.“Do not mix User Shares and Disk Shares” is catastrophic if ignored. Using
:::danger[...]may better convey severity thancaution[Critical].-:::caution[Critical] +:::danger[Critical]docs/unraid-os/system-administration/secure-your-server/secure-your-flash-drive.mdx (1)
49-57: Admonition syntax LGTM; clarify SMB “Secure”/guest wording.“Secure with guest write access” is not a standard Unraid SMB mode and could confuse readers. Recommend clarifying “Public” vs “Secure” vs “Private,” and explicitly advising no guest access.
Apply this diff:
- - **Avoid public access:** Never leave the flash drive share set to **Public** or **Secure** with guest write access. + - **Avoid public/guest access:** Never set the flash drive share to **Public**. If you must use **Secure**, disable guest access and only grant write to specific users; prefer **Private**.If you want, I can align this phrasing with the exact SMB UI labels shown in the current Unraid version.
docs/unraid-os/system-administration/secure-your-server/securing-your-connection.mdx (2)
203-211: Remove ellipsis and tighten the info title.Ellipsis in titles reads awkwardly; suggest a concise, action-oriented title.
Apply this diff:
-:::info[When using a custom certificate, you are responsible for...] +:::info[Using a custom certificate: your responsibilities]
10-14: Minor: use title case for the admonition title
Change in docs/unraid-os/system-administration/secure-your-server/securing-your-connection.mdx:
:::important[The importance of SSL] → :::important[The Importance of SSL]Repo still contains many admonitions with inline titles (rg returned multiple matches); run the ripgrep you suggested to locate and standardize them for consistency.
docs/unraid-os/using-unraid-to/create-virtual-machines/windows-on-a-vm.mdx (1)
296-300: Fix inconsistent admonition title formattingReplace the space-delimited admonition title with bracketed form in docs/unraid-os/using-unraid-to/create-virtual-machines/windows-on-a-vm.mdx (lines 296–300)
-:::caution data loss risk +:::caution[Data loss risk]
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (36)
docs/API/cli.mdx(3 hunks)docs/API/index.mdx(1 hunks)docs/API/upcoming-features.mdx(4 hunks)docs/contribute/style-guide.mdx(2 hunks)docs/unraid-connect/remote-access.mdx(1 hunks)docs/unraid-os/advanced-configurations/optimize-storage/zfs-storage.mdx(6 hunks)docs/unraid-os/getting-started/set-up-unraid/customize-unraid-settings.mdx(1 hunks)docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.mdx(1 hunks)docs/unraid-os/system-administration/advanced-tools/command-line-interface.mdx(3 hunks)docs/unraid-os/system-administration/advanced-tools/wake-on-lan.mdx(2 hunks)docs/unraid-os/system-administration/maintain-and-update/changing-the-flash-device.mdx(5 hunks)docs/unraid-os/system-administration/maintain-and-update/upgrading-unraid.mdx(2 hunks)docs/unraid-os/system-administration/secure-your-server/secure-your-flash-drive.mdx(1 hunks)docs/unraid-os/system-administration/secure-your-server/secure-your-outgoing-comms.mdx(1 hunks)docs/unraid-os/system-administration/secure-your-server/securing-your-connection.mdx(3 hunks)docs/unraid-os/system-administration/secure-your-server/securing-your-data.mdx(1 hunks)docs/unraid-os/system-administration/secure-your-server/security-fundamentals.mdx(3 hunks)docs/unraid-os/system-administration/secure-your-server/tailscale.mdx(6 hunks)docs/unraid-os/system-administration/secure-your-server/user-management.mdx(3 hunks)docs/unraid-os/system-administration/secure-your-server/wireguard.mdx(2 hunks)docs/unraid-os/troubleshooting/common-issues/data-recovery.mdx(7 hunks)docs/unraid-os/troubleshooting/faq.mdx(3 hunks)docs/unraid-os/troubleshooting/troubleshooting.mdx(1 hunks)docs/unraid-os/using-unraid-to/create-virtual-machines/vm-conversion-and-migration.mdx(8 hunks)docs/unraid-os/using-unraid-to/create-virtual-machines/vm-setup.mdx(5 hunks)docs/unraid-os/using-unraid-to/create-virtual-machines/windows-on-a-vm.mdx(5 hunks)docs/unraid-os/using-unraid-to/customize-your-experience/multi-language-support.mdx(2 hunks)docs/unraid-os/using-unraid-to/customize-your-experience/plugins.mdx(1 hunks)docs/unraid-os/using-unraid-to/manage-storage/apple-time-machine.mdx(1 hunks)docs/unraid-os/using-unraid-to/manage-storage/array-configuration.mdx(19 hunks)docs/unraid-os/using-unraid-to/manage-storage/cache-pools.mdx(14 hunks)docs/unraid-os/using-unraid-to/manage-storage/file-systems.mdx(11 hunks)docs/unraid-os/using-unraid-to/manage-storage/shares.mdx(6 hunks)docs/unraid-os/using-unraid-to/run-docker-containers/community-applications.mdx(2 hunks)docs/unraid-os/using-unraid-to/run-docker-containers/managing-and-customizing-containers.mdx(6 hunks)docs/unraid-os/using-unraid-to/run-docker-containers/overview.mdx(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-09-17T16:28:59.403Z
Learnt from: elibosley
PR: unraid/docs#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/system-administration/maintain-and-update/upgrading-unraid.mdxdocs/unraid-os/advanced-configurations/optimize-storage/zfs-storage.mdx
⏰ 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 (40)
docs/unraid-os/system-administration/advanced-tools/wake-on-lan.mdx (2)
32-36: LGTM — standardized admonition title syntaxSwitched to bracketed title form
:::caution[Hardware compatibility]; matches the PR objective and is valid in Docusaurus.
79-90: LGTM; confirm nested admonition renders insideThe bracketed title syntax looks good. Since this admonition is nested within a
block, please confirm it renders correctly in the preview/local build (no parsing quirks with nesting/indentation).docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.mdx (1)
10-14: Admonition title syntax looks good.Bracketed title
:::info[Localize]is valid and consistent with the PR’s goal.docs/unraid-os/getting-started/set-up-unraid/customize-unraid-settings.mdx (1)
10-14: Consistent conversion to bracketed admonition titles.
:::tip[Tailscale integration]renders correctly.docs/contribute/style-guide.mdx (2)
88-94: LGTM on bracketed title.Keeps style consistent; no content changes.
99-105: Second admonition update also looks good.Matches the new convention.
docs/unraid-os/using-unraid-to/run-docker-containers/overview.mdx (1)
47-53: Confirm added support statement.New bullet clarifies support scope. Please confirm this phrasing with product/docs owners for policy alignment.
docs/unraid-os/using-unraid-to/manage-storage/apple-time-machine.mdx (1)
27-40: Admonition title formatting updated correctly.
:::caution[Before you begin]is valid; no behavioral change.docs/unraid-os/system-administration/secure-your-server/securing-your-data.mdx (1)
35-39: Admonition update is correct.
:::important[Before encrypting]matches the standardized style.docs/API/index.mdx (1)
40-46: Both admonition title conversions look good.Consistent with site-wide formatting.
Also applies to: 78-89
docs/unraid-connect/remote-access.mdx (1)
13-18: Link target existsThe file docs/unraid-os/system-administration/maintain-and-update/upgrading-unraid.mdx exists and the relative link in docs/unraid-connect/remote-access.mdx correctly points to it.
docs/API/upcoming-features.mdx (1)
9-13: Admonition titles standardized correctlyAll converted blocks render-friendly with bracketed titles and proper closing. No content regressions spotted.
Also applies to: 132-136, 153-160, 171-175, 177-181
docs/unraid-os/using-unraid-to/customize-your-experience/plugins.mdx (1)
39-45: Good conversion and helpful new guidance
- Bracketed title format is correct.
- Added bullet about keeping plugins updated is appropriate and consistent with list tone.
docs/unraid-os/using-unraid-to/run-docker-containers/community-applications.mdx (1)
77-81: Admonition title updates look goodBoth tips use the correct bracketed syntax and maintain consistent casing.
Also applies to: 119-126
docs/unraid-os/system-administration/secure-your-server/user-management.mdx (1)
10-19: Consistent admonition formattingAll three blocks properly converted to bracketed titles; spacing and closures are correct.
Also applies to: 75-80, 172-176
docs/unraid-os/system-administration/secure-your-server/wireguard.mdx (1)
45-53: Bracketed titles for note/important are correctNo content or structure issues detected; these will render as expected in Docusaurus.
Also applies to: 103-110
docs/unraid-os/troubleshooting/troubleshooting.mdx (1)
5-9: Admonition formatting LGTMBoth info and tip use correct bracketed titles; content untouched.
Also applies to: 11-15
docs/unraid-os/system-administration/secure-your-server/security-fundamentals.mdx (1)
8-12: Solid, consistent conversionBrackets applied correctly across note/caution blocks. No broken links or tables detected nearby.
Also applies to: 62-66, 78-90
docs/API/cli.mdx (1)
9-13: CLI admonitions standardized — OIDC guide verified
- Title conversions are correct across info/tip blocks.
- Linked guide found at docs/API/oidc-provider-setup.mdx; references in docs/API/cli.mdx (140–145, e.g. line 142) resolve correctly.
docs/unraid-os/using-unraid-to/run-docker-containers/managing-and-customizing-containers.mdx (1)
11-15: Admonition title standardization looks good.Bracketed titles render consistently across Docusaurus; these blocks are correct and properly closed.
Also applies to: 38-42, 54-58, 106-113, 141-147, 260-264
docs/unraid-os/troubleshooting/faq.mdx (1)
163-179: Admonition syntax updates are correct.Bracketed headings are valid and closures are balanced.
Also applies to: 295-300, 313-321
docs/unraid-os/system-administration/secure-your-server/tailscale.mdx (1)
81-91: Good conversion to bracketed admonition titles.All updated blocks are syntactically correct and improve consistency.
Also applies to: 93-98, 119-125, 136-145, 173-178, 191-196
docs/unraid-os/system-administration/maintain-and-update/upgrading-unraid.mdx (1)
13-18: LGTM on prerequisites and best-practices sections.Clearer structure; syntax is correct.
Also applies to: 19-28
docs/unraid-os/troubleshooting/common-issues/data-recovery.mdx (1)
33-37: Admonition conversions read well.Content and closures are correct; additions improve clarity.
Also applies to: 39-45, 100-104, 174-180, 223-226, 288-292, 346-355, 372-377
docs/unraid-os/system-administration/advanced-tools/command-line-interface.mdx (1)
13-17: Admonition header updates are correct.Balanced blocks; titles render properly.
Also applies to: 25-33, 189-193
docs/unraid-os/using-unraid-to/manage-storage/cache-pools.mdx (1)
20-29: Consistent bracketed admonitions across sections.All updated instances look correct and consistent.
Also applies to: 196-203, 210-214, 222-228, 261-266, 336-342, 354-358, 366-370, 382-392, 414-418, 431-443, 485-491
docs/unraid-os/using-unraid-to/customize-your-experience/multi-language-support.mdx (1)
21-28: Admonition updates and added bullets look good.Clearer expectations around logs and plugin translations; syntax is correct.
Also applies to: 50-54
docs/unraid-os/using-unraid-to/manage-storage/shares.mdx (1)
59-67: Admonition syntax updates look good.Bracketed titles render consistently and improve scannability. No content regressions spotted.
Also applies to: 79-83, 167-174, 301-306, 351-356, 357-363, 604-607
docs/unraid-os/using-unraid-to/create-virtual-machines/vm-conversion-and-migration.mdx (1)
13-20: Standardized admonitions LGTM.All converted blocks render correctly with clear titles. No broken links or content shifts detected.
Also applies to: 155-171, 173-182, 192-199, 306-310, 318-322, 408-413, 455-464
docs/unraid-os/advanced-configurations/optimize-storage/zfs-storage.mdx (1)
11-16: Admonition formatting improvements approved.Titles are now consistent and clearer; content unchanged. Good work.
Also applies to: 35-39, 81-85, 106-111, 129-137, 177-183, 200-204, 223-227, 265-270, 338-342
docs/unraid-os/system-administration/maintain-and-update/changing-the-flash-device.mdx (1)
46-57: Looks good — consistent admonition titles and accurate guidance.The sections align with our flash backup/replace flows and the “Use custom” creator path.
Also applies to: 63-74, 103-109, 111-115, 161-165, 217-223
docs/unraid-os/using-unraid-to/manage-storage/file-systems.mdx (1)
52-60: Admonition standardization approved.Anchors and cross‑refs read correctly; titles improve clarity.
Also applies to: 62-71, 115-119, 137-144, 171-175, 244-249, 275-279, 387-396, 398-405, 553-557, 613-623, 652-658
docs/unraid-os/using-unraid-to/manage-storage/array-configuration.mdx (1)
58-68: Bulk admonition formatting changes LGTM.Consistent bracketed titles and improved emphasis across array ops, rebuilds, and parity topics.
Also applies to: 115-120, 148-153, 159-163, 190-195, 250-256, 339-345, 365-369, 377-385, 410-414, 583-584, 593-598, 629-635, 637-643, 646-651, 673-678, 679-683, 916-920, 1173-1177, 1190-1195, 1210-1214, 1383-1386
docs/unraid-os/system-administration/secure-your-server/secure-your-outgoing-comms.mdx (1)
71-79: Tailscale tip block conversion looks good.Clearer title; content unchanged.
docs/unraid-os/system-administration/secure-your-server/securing-your-connection.mdx (1)
132-137: Good: titled tip clarifies fallback behavior.No issues.
docs/unraid-os/using-unraid-to/create-virtual-machines/windows-on-a-vm.mdx (5)
13-19: Admonition title syntax standardized — looks good.
Bracketed title form is correct here.
51-56: Admonition title syntax standardized — looks good.
Bracketed title form is correct here.
81-88: Admonition title syntax standardized — looks good.
Bracketed title form is correct here.
114-118: Admonition title syntax standardized — looks good.
Bracketed title form is correct here.
257-263: Admonition title syntax standardized — looks good.
Bracketed title form is correct here.
There was a problem hiding this comment.
Actionable comments posted: 0
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/using-unraid-to/manage-storage/array-configuration.mdx (1)
1312-1318: Fix product-name typo: replace "Unleased" with "Unleashed".
File: docs/unraid-os/using-unraid-to/manage-storage/array-configuration.mdx (around line 1316).
🧹 Nitpick comments (3)
docs/unraid-os/using-unraid-to/manage-storage/array-configuration.mdx (3)
158-162: Minor title consistency nit.Title ends with a colon here (“Important Note:”) while similar titles elsewhere don’t. Consider standardizing.
410-414: Usewarningtype to match the title.Admonition type is
cautionbut the title says “Warning”. Prefer:::warningfor semantic alignment.-:::caution[Warning] +:::warning[Warning]
1045-1052: Close marker placement nit.There’s an extra blank line immediately before the closing
:::. Consider tightening to keep admonition blocks consistent.Do not use **New Config** if your goal is to rebuild a disk. Performing a New Config clears the array history required for a rebuild, and Unraid will not offer to rebuild the disk afterward. Follow the disk rebuild procedure instead. - :::
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
docs/unraid-os/system-administration/maintain-and-update/upgrading-unraid.mdx(2 hunks)docs/unraid-os/using-unraid-to/create-virtual-machines/vm-setup.mdx(5 hunks)docs/unraid-os/using-unraid-to/manage-storage/array-configuration.mdx(20 hunks)docs/unraid-os/using-unraid-to/manage-storage/cache-pools.mdx(14 hunks)docs/unraid-os/using-unraid-to/run-docker-containers/managing-and-customizing-containers.mdx(7 hunks)
🚧 Files skipped from review as they are similar to previous changes (4)
- docs/unraid-os/using-unraid-to/manage-storage/cache-pools.mdx
- docs/unraid-os/using-unraid-to/run-docker-containers/managing-and-customizing-containers.mdx
- docs/unraid-os/using-unraid-to/create-virtual-machines/vm-setup.mdx
- docs/unraid-os/system-administration/maintain-and-update/upgrading-unraid.mdx
⏰ 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 (17)
docs/unraid-os/using-unraid-to/manage-storage/array-configuration.mdx (17)
58-62: Admonition syntax conversion looks good.Bracketed title renders well and content unchanged.
115-119: Hot-swap tip formatting is correct.No semantic changes introduced.
148-152: Critical note admonition is correct.Accurately warns against formatting pre-cleared disks.
250-255: Parity requirements block reads well.Rules are clear; formatting OK.
339-345: “Remember” caution block is clear.Good use of bracketed title.
377-385: Important tips block is formatted correctly.Content and emphasis retained.
471-476: Rebuild tips look good.Admonition within details renders fine.
593-598: “Additional notes” block is fine.No issues.
629-635: Prerequisites admonition is correct.Good placement before the steps.
637-643: Warnings block reads well.Multiple bullets within admonition are fine.
646-650: Note before procedure is OK.If build warnings arise, add a blank line before
:::note(MDX parsers sometimes prefer it).
679-683: Never-format warning is clear.Good emphasis.
1173-1178: Automations info block is correct.Reads well; no issues.
1190-1196: Quick recap block is correct.Clear summary; formatting OK.
1210-1215: Special cases note is fine.Accurately sets expectations.
1326-1330: Blacklist caution block is clear.Accurately describes GUID issues; formatting OK.
1383-1387: Rebuild time info block is correct.Consistent with earlier usage.
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/troubleshooting/common-issues/unclean-shutdowns.mdx (1)
24-35: Minor grammar fix in UPS tip.Tweak sentence flow.
- Look into the [NUT plugin](https://unraid.net/community/apps/c/plugins/p4?srsltid=AfmBOop675PrJQW4iqb4JBN3GyPpwDDiSmnZReq78t27XyxkFdMX8inO#:~:text=NUT%20%2D%20Network%20UPS%20Tools) for broader compatibility for more advanced UPS models or unsupported hardware. + Look into the [NUT plugin](https://unraid.net/community/apps/c/plugins/p4?srsltid=AfmBOop675PrJQW4iqb4JBN3GyPpwDDiSmnZReq78t27XyxkFdMX8inO#:~:text=NUT%20%2D%20Network%20UPS%20Tools) for broader compatibility with more advanced UPS models or unsupported hardware.
🧹 Nitpick comments (4)
docs/unraid-os/troubleshooting/licensing-faq.mdx (1)
92-96: LGTM. Optional nit: remove blank line after the admonition opener for consistency.Bracketed title syntax is correct. Consider tightening spacing to match common admonition style in the repo.
- :::note[Instructional Video] - + :::note[Instructional Video] Watch the [Activation Code Instructional Video](https://www.loom.com/share/3ceb40440240474aaa80a0b7e3e69cb2) for step-by-step guidance.docs/unraid-os/using-unraid-to/create-virtual-machines/overview-and-system-prep.mdx (1)
158-163: Info block title update — minor copy nit (optional).Consider Title Case for consistency across headings/admonitions: “Always Changing”.
docs/unraid-os/troubleshooting/common-issues/unclean-shutdowns.mdx (1)
33-33: Strip tracking params from external link.Remove
srsltid(and similar) to reduce fragility and avoid tracking noise.- Look into the [NUT plugin](https://unraid.net/community/apps/c/plugins/p4?srsltid=AfmBOop675PrJQW4iqb4JBN3GyPpwDDiSmnZReq78t27XyxkFdMX8inO#:~:text=NUT%20%2D%20Network%20UPS%20Tools) for broader compatibility with more advanced UPS models or unsupported hardware. + Look into the [NUT plugin](https://unraid.net/community/apps/c/plugins/p4) for broader compatibility with more advanced UPS models or unsupported hardware.docs/unraid-os/troubleshooting/common-issues/system-crashes-and-stability.mdx (1)
221-227: Admonition inside: verify rendering or switch to MDX component.Admonitions sometimes don’t render inside raw HTML blocks depending on MDX/remark configuration. If this doesn’t render as expected within
, prefer the MDX component.Try this alternative if needed:
- :::tip[Recommendations] - - - Use manufacturer utilities for risk-free updates, such as [ASUS Armoury Crate](https://www.asus.com/supportonly/armoury%20crate/helpdesk_download/), [Gigabyte @BIOS](https://www.gigabyte.com/Support/Consumer/Download), or [MSI Center](https://www.msi.com/Landing/MSI-Center). - - Check your motherboard's BIOS settings for automatic update options if available. - - ::: + <Admonition type="tip" title="Recommendations"> + + - Use manufacturer utilities for risk-free updates, such as [ASUS Armoury Crate](https://www.asus.com/supportonly/armoury%20crate/helpdesk_download/), [Gigabyte @BIOS](https://www.gigabyte.com/Support/Consumer/Download), or [MSI Center](https://www.msi.com/Landing/MSI-Center). + - Check your motherboard's BIOS settings for automatic update options if available. + + </Admonition>
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (11)
docs/unraid-connect/automated-flash-backup.mdx(1 hunks)docs/unraid-connect/remote-access.mdx(2 hunks)docs/unraid-os/troubleshooting/common-issues/boot-and-startup-failures.mdx(1 hunks)docs/unraid-os/troubleshooting/common-issues/system-crashes-and-stability.mdx(3 hunks)docs/unraid-os/troubleshooting/common-issues/unclean-shutdowns.mdx(2 hunks)docs/unraid-os/troubleshooting/diagnostics/capture-diagnostics-and-logs.mdx(2 hunks)docs/unraid-os/troubleshooting/licensing-faq.mdx(1 hunks)docs/unraid-os/using-unraid-to/create-virtual-machines/overview-and-system-prep.mdx(3 hunks)docs/unraid-os/using-unraid-to/create-virtual-machines/unraid-as-a-vm.mdx(1 hunks)docs/unraid-os/using-unraid-to/create-virtual-machines/windows-on-a-vm.mdx(6 hunks)docs/unraid-os/using-unraid-to/manage-storage/apple-time-machine.mdx(1 hunks)
✅ Files skipped from review due to trivial changes (2)
- docs/unraid-connect/remote-access.mdx
- docs/unraid-connect/automated-flash-backup.mdx
🚧 Files skipped from review as they are similar to previous changes (2)
- docs/unraid-os/using-unraid-to/manage-storage/apple-time-machine.mdx
- docs/unraid-os/using-unraid-to/create-virtual-machines/windows-on-a-vm.mdx
⏰ 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 (12)
docs/unraid-os/troubleshooting/common-issues/boot-and-startup-failures.mdx (1)
173-177: Admonition title syntax LGTM; build check recommended.Bracketed title form
:::warning[Multiple parity drives]is correct and consistent with the PR’s goal. Please run a docs build to confirm no admonition parsing regressions project-wide.docs/unraid-os/using-unraid-to/create-virtual-machines/overview-and-system-prep.mdx (3)
72-77: Switched to bracketed admonition title — looks good.
:::tip[GPU passthrough compatibility]renders as expected with Docusaurus/remark-admonitions.
118-126: Explicit title on important admonition — good standardization.
150-156: Tip block with bracketed title — consistent with the new style.docs/unraid-os/troubleshooting/diagnostics/capture-diagnostics-and-logs.mdx (2)
58-69: LGTM on bracketed title conversion.Consistent with the new admonition style; no content issues found.
13-22: Bracketed admonition title is supported — confirm site config and buildDocusaurus (v2/v3) supports :::info[Title]; repo search found no inline‑title admonitions — confirm the project’s Docusaurus version and remark‑admonitions setup and run a local docs build to validate rendering.
docs/unraid-os/using-unraid-to/create-virtual-machines/unraid-as-a-vm.mdx (2)
17-23: Approve: bracketed admonition syntax supportedpackage.json lists @docusaurus/core 3.8.1 and Docusaurus v3 (≥3.0.0) supports bracketed admonition titles, so
:::caution[Important considerations]is valid.
25-31: Prerequisites admonition conversion LGTM — verify minimum'Unraid version 6.4.0 or higher' occurs only in docs/unraid-os/using-unraid-to/create-virtual-machines/unraid-as-a-vm.mdx; no conflicting VM-doc minima found. Verify with product/release notes that 6.4.0 is the intended minimum and update docs if needed.
docs/unraid-os/troubleshooting/common-issues/unclean-shutdowns.mdx (1)
13-22: Admonition title syntax verified — safe to merge.rg found 32 bracketed admonitions across the docs and package.json lists @docusaurus/core v3.8.1, so the
:::important[Title]form is already in use and supported; one legacy inline-title admonition remains (count = 1) — optional to convert.docs/unraid-os/troubleshooting/common-issues/system-crashes-and-stability.mdx (3)
46-50: Clear, actionable “important” admonition.Title and closing fence look correct; good standardization.
56-71: Caution admonition reads well and renders consistently.No issues found; nice consolidation under a single admonition.
38-44: Confirm Docusaurus version / mdx admonitions configBracketed-title syntax (:: :note[Title]) is the Docusaurus v3/mdx-directive form; v2 uses the space-style (:: :note Your Title). Verify the site is on Docusaurus v3 or that v3’s mdx1Compat.admonitions is enabled; otherwise revert to v2-style titles. Check package.json for @docusaurus/core/@docusaurus/preset-classic version and docusaurus.config.js for mdx1Compat.admonitions.
docs/unraid-os/troubleshooting/common-issues/system-crashes-and-stability.mdx
Outdated
Show resolved
Hide resolved
Summary by CodeRabbit