feat: Add root-level Updating Unraid guidance#464
Merged
Conversation
Contributor
📝 WalkthroughWalkthroughRenames "Upgrading Unraid" to "Updating Unraid", adds a new "Updating Unraid" category and a release-types page, updates links/frontmatter and several sidebar positions, adds client-side redirects, and updates sidebar grouping logic to place release notes and version history under the new category. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
unraid-docs | aeff74d | Commit Preview URL Branch Preview URL |
Apr 23 2026, 02:01 AM |
elibosley
changed the title
elibosley
changed the title
elibosley
changed the title
- Purpose: document the public Unraid OS release levels users see when choosing updates. - Before: the upgrade guide mentioned Stable and Next, but did not explain Stable, Beta, RC, patch, or withdrawn prerelease meanings in one place. - Problem: users evaluating prerelease builds had to infer risk, license impact, and reporting expectations from scattered release notes and FAQ text. - Change: add a dedicated release types page under Maintain and update, covering release readiness, Update OS channels, eligibility notes, and prerelease reporting guidance. - Implementation: link the new page from the Upgrading Unraid guide and keep validation scoped to targeted MDX lint rather than the full build.
- Purpose: turn the update-related docs into a guided user journey. - Before: Release types, Upgrading Unraid, and Version history were connected only by narrow point-to-point links. - Problem: users deciding what to install still had to assemble the update flow from separate pages. - Change: add an Updating Unraid landing page that summarizes preparation, release choice, WebGUI update steps, version history usage, prerelease cautions, and support next steps. - Implementation: reposition the maintain-and-update pages, link Version history back to the update journey, and tighten the old beta/RC guidance. - Validation: ran targeted remark lint across the touched MDX files.
- Purpose: make Updating Unraid the root page for the maintain-and-update category instead of a separate child page. - Before: the section used Docusaurus generated-index behavior and listed Updating Unraid as another page alongside supporting docs. - Problem: the update journey was structurally weaker than the intended root-page-and-subpages IA. - Change: rename the landing page to the category index, remove the generated-index override, and update links to the index page. - Implementation: use Docusaurus category index convention so Release types, Upgrading Unraid, and related pages remain subpages. - Validation: ran targeted remark lint across the touched MDX files.
- Purpose: make Updating Unraid a first-class Unraid OS category instead of burying it under system administration. - Before: update guidance lived under System administration > Maintain and update, mixing OS update decisions with boot-device maintenance. - Problem: updates are a core lifecycle path and should read like a root-level user journey, while boot-device replacement is maintenance. - Change: move Updating Unraid, Release types, Upgrading Unraid, and update/downgrade partials into a root-level Updating Unraid category. - Implementation: relabel the old section as Maintenance, adjust root category ordering, update internal links, and add redirects from old update URLs to the new location. - Validation: ran targeted remark lint for moved/edited Markdown and pnpm run check-case-sensitivity.
- Purpose: correct the Unraid Connect remote access guide so it matches the current Unraid 7.2.x settings UI. - Before: the guide described dynamic remote access choices and dashboard activation steps that are not exposed by the current settings form. - Problem: users on Unraid 7.2.4 only see Disabled/Always plus Static/UPnP forwarding, so the guide sent them looking for options that do not exist. - Change: document the current Allow Remote Access, Forward Type, and WAN Port controls, and clarify that on-demand dynamic remote access is not currently exposed. - How: replace the dynamic/static tabbed setup with current 7.2.x setup guidance and remove the overview claim about dynamic remote access.
This reverts commit ea48dde.
- Move the root-level Updating Unraid category below Troubleshooting and above Release notes. - Restore the surrounding Unraid OS categories to their prior relative order so the update journey no longer interrupts the main topic flow. - Shift Version history after Release notes to preserve the release-reference ordering.
- Render Release notes and Version history inside the Updating Unraid sidebar category. - Keep the underlying document files in place so existing release-note and version-history URLs do not change. - Preserve the existing semver grouping for release-note entries after they are nested.
- Keep the Updating Unraid index focused as a short navigation hub. - Move detailed release-type and procedure content behind the dedicated Release types and Upgrading Unraid pages. - Link to the release-notes category instead of a specific version so the page stays current.
elibosley
force-pushed
the
codex/unraid-release-types
branch
from
f03f335 to
0554642
Compare
- Purpose: add a prominent path from the 7.3.0 release candidate notes to the release types guide. - Before: readers saw the release candidate warning without an inline explanation of Stable, Beta, and RC terminology. - Problem: users curious about prerelease labels had to discover the release types page elsewhere. - Now: the top of the 7.3.0-rc.1 changelog links directly to the Unraid OS release types guide. - How: add one short sentence beneath the release candidate warning using the existing docs route.
- Purpose: align the PR with account app terminology and remove redundant update navigation. - Before: new release-type content used prerelease while the account app says pre-release, and Updating Unraid contained a nested Upgrading Unraid page. - Problem: the spelling mismatch created inconsistent product language, and the update/upgrading hierarchy was hard to scan in the sidebar. - Now: new source docs use pre-release wording, the Updating Unraid category links directly to the update guide, and the old nested guide path redirects to the category root. - How: move the update procedure into updating-unraid/index.mdx, delete upgrading-unraid.mdx, update internal links, and preserve redirects for old URLs.
- Purpose: Clarify how Stable releases cover both minor releases and patch releases. - Before: Patch release appeared as a separate release type beside Stable, which made it look like a separate readiness category. - Problem: Readers could miss that patch releases are still Stable releases and that Unraid minor releases usually carry the larger series-level changes. - New behavior: The Stable row now shows a typical .0-to-patch sequence, and the Stable section explains what Unraid minor and patch releases typically contain. - Implementation: Removed the separate Patch release row, renamed feature releases to minor releases, and added concise lifecycle guidance for .0 and later patch releases.
- Purpose: Explain that release branch selection is managed through the Unraid account app. - Before: The docs told users to choose Stable or Next in the Update OS tool, implying the branch could be changed from within the OS. - Problem: Users cannot switch release branches directly inside the OS, so the guidance pointed them at the wrong control surface. - New behavior: The release-types page and modern update steps now say Update OS shows updates for the server's current branch, and branch changes happen through Manage Unraid.net Account in the account app. - Implementation: Renamed the channels section, added Account app guidance, and changed the update procedure to apply the selected release rather than assuming a stable update.
- Purpose: Rename the version listing page from Version history to Version Archive. - Before: The page title and heading used Version history, and the intro only pointed users toward update decision pages. - Problem: The page is an archive of releases and downloads, while users looking to install or update need clearer direction to the right tool. - New behavior: The page is labeled Version Archive and its intro directs existing servers to the built-in updater, new boot devices to USB Creator, and release selection questions to release types. - Implementation: Updated the page front matter title, H1, intro copy, USB Creator link, and updater link to the standard update process anchor.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
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/updating-unraid/partials/upgrade-modern.mdx (1)
1-7:⚠️ Potential issue | 🟡 MinorUse consistent “update” terminology in this instruction block.
Nice rename on Line 1, but Line 7 still says “complete the upgrade.” To match the new “Updating Unraid” terminology and avoid mixed wording, please switch that to “complete the update.”
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/unraid-os/updating-unraid/partials/upgrade-modern.mdx` around lines 1 - 7, Replace the inconsistent wording "complete the upgrade" with "complete the update" so the instruction block uses "update" everywhere; specifically edit the sentence in the list item that currently reads "When prompted, reboot your server to complete the upgrade." to instead read "When prompted, reboot your server to complete the update." and keep all other "Updating Unraid" and "Update OS" references unchanged.
🧹 Nitpick comments (2)
docs/unraid-os/updating-unraid/release-types.mdx (1)
88-91: Optional readability polish: vary repeated bullet openings.The four bullets in this block read a bit repetitive (“Use …”). Consider rephrasing one or two for smoother flow.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/unraid-os/updating-unraid/release-types.mdx` around lines 88 - 91, The four-item bullet block that currently repeats “Use …” should be varied for readability: keep the first bullet as-is for "Stable", change the second to start with "Choose RC…" (or "Run RC…" ) for validation wording, reword the third to "Opt into Beta…" (or "Join Beta…") to signal voluntary testing, and rephrase the fourth to start with "Avoid staying on old…" (or "Do not remain on outdated…") while preserving the original meanings for "Stable", "RC", "Beta" and the roll-back guidance.docs/unraid-os/release-notes/_category_.json (1)
3-3: Consider documenting thatpositionis effectively overridden during regrouping.Given sidebar regrouping logic, this value may not drive final nav order, which can be confusing for future edits.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/unraid-os/release-notes/_category_.json` at line 3, Update the metadata to clarify that the "position" field does not control final sidebar ordering because the site’s regrouping logic can override it; add a short explanatory note (for example in the category's "description" field or adjacent documentation) stating that "position" is used for initial ordering but may be overridden during sidebar regrouping so editors should not rely on it for final nav order, and reference the regrouping/sidebar logic in the note for future maintainers.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@sidebar-semver-sort.js`:
- Around line 23-33: The regrouping relies on locale-specific item.label text;
replace those direct label comparisons in itemLabel and
groupReleaseReferencesUnderUpdatingUnraid (and the other comparison sites around
the earlier checks at the other locations) with a stable-identifier-first check:
implement a helper (e.g., stableIdentifier(item)) that returns one of
item.link?.id || item.id || item.customProps?.id (or any canonical id field your
sidebar items expose) and only falls back to item.label?.toLowerCase() when no
stable id exists, then use that helper in the category/name comparisons so
localized labels no longer break the regroup/sort logic.
---
Outside diff comments:
In `@docs/unraid-os/updating-unraid/partials/upgrade-modern.mdx`:
- Around line 1-7: Replace the inconsistent wording "complete the upgrade" with
"complete the update" so the instruction block uses "update" everywhere;
specifically edit the sentence in the list item that currently reads "When
prompted, reboot your server to complete the upgrade." to instead read "When
prompted, reboot your server to complete the update." and keep all other
"Updating Unraid" and "Update OS" references unchanged.
---
Nitpick comments:
In `@docs/unraid-os/release-notes/_category_.json`:
- Line 3: Update the metadata to clarify that the "position" field does not
control final sidebar ordering because the site’s regrouping logic can override
it; add a short explanatory note (for example in the category's "description"
field or adjacent documentation) stating that "position" is used for initial
ordering but may be overridden during sidebar regrouping so editors should not
rely on it for final nav order, and reference the regrouping/sidebar logic in
the note for future maintainers.
In `@docs/unraid-os/updating-unraid/release-types.mdx`:
- Around line 88-91: The four-item bullet block that currently repeats “Use …”
should be varied for readability: keep the first bullet as-is for "Stable",
change the second to start with "Choose RC…" (or "Run RC…" ) for validation
wording, reword the third to "Opt into Beta…" (or "Join Beta…") to signal
voluntary testing, and rephrase the fourth to start with "Avoid staying on old…"
(or "Do not remain on outdated…") while preserving the original meanings for
"Stable", "RC", "Beta" and the roll-back guidance.
🪄 Autofix (Beta)
❌ Autofix failed (check again to retry)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 48119885-79da-4e5a-b9d5-1af5b7664580
📒 Files selected for processing (25)
docs/unraid-os/advanced-configurations/_category_.jsondocs/unraid-os/download_list.mdxdocs/unraid-os/release-notes/7.2.0.mddocs/unraid-os/release-notes/7.2.1.mddocs/unraid-os/release-notes/7.2.2.mddocs/unraid-os/release-notes/7.2.3.mddocs/unraid-os/release-notes/7.2.4.mddocs/unraid-os/release-notes/7.2.5.mddocs/unraid-os/release-notes/7.3.0.mddocs/unraid-os/release-notes/_category_.jsondocs/unraid-os/system-administration/_category_.jsondocs/unraid-os/system-administration/maintain-and-update/_category_.jsondocs/unraid-os/system-administration/maintain-and-update/changing-the-flash-device.mdxdocs/unraid-os/troubleshooting/_category_.jsondocs/unraid-os/updating-unraid/_category_.jsondocs/unraid-os/updating-unraid/index.mdxdocs/unraid-os/updating-unraid/partials/manual-downgrade-command-line.mdxdocs/unraid-os/updating-unraid/partials/manual-downgrade-simplest.mdxdocs/unraid-os/updating-unraid/partials/upgrade-legacy-611-612.mdxdocs/unraid-os/updating-unraid/partials/upgrade-modern.mdxdocs/unraid-os/updating-unraid/release-types.mdxdocs/unraid-os/using-unraid-to/_category_.jsondocs/unraid-os/using-unraid-to/run-docker-containers/community-applications.mdxdocusaurus.config.tssidebar-semver-sort.js
Comment on lines
+23
to
+33
| function itemLabel(item) { | ||
| return item.label?.toLowerCase(); | ||
| } | ||
|
|
||
| function isVersionHistoryDoc(item) { | ||
| return item.type === "doc" && item.id === "unraid-os/download_list"; | ||
| } | ||
|
|
||
| function groupReleaseReferencesUnderUpdatingUnraid(items) { | ||
| const updatingIndex = items.findIndex((item) => | ||
| item.type === "category" && itemLabel(item) === "updating unraid" |
Contributor
There was a problem hiding this comment.
Locale-dependent matching may break regrouping outside English.
Line 33, Line 47, and Line 77 rely on item.label string equality. In localized sidebars, translated labels can prevent the regroup/sort logic from triggering.
Suggested fix (use stable identifiers with label fallback)
function itemLabel(item) {
return item.label?.toLowerCase();
}
+function isUpdatingUnraidCategory(item) {
+ if (item.type !== "category") return false;
+ return (
+ item.link?.id === "unraid-os/updating-unraid/index" ||
+ item.href === "/unraid-os/updating-unraid/" ||
+ itemLabel(item) === "updating unraid"
+ );
+}
+
+function isReleaseNotesCategory(item) {
+ if (item.type !== "category") return false;
+ return (
+ item.href === "/category/release-notes/" ||
+ (item.items || []).some(
+ (child) =>
+ child.type === "doc" &&
+ typeof child.id === "string" &&
+ child.id.startsWith("unraid-os/release-notes/")
+ ) ||
+ itemLabel(item) === "release notes"
+ );
+}
+
function isVersionHistoryDoc(item) {
return item.type === "doc" && item.id === "unraid-os/download_list";
}
function groupReleaseReferencesUnderUpdatingUnraid(items) {
- const updatingIndex = items.findIndex((item) =>
- item.type === "category" && itemLabel(item) === "updating unraid"
- );
+ const updatingIndex = items.findIndex((item) => isUpdatingUnraidCategory(item));
...
- } else if (item.type === "category" && itemLabel(item) === "release notes") {
+ } else if (isReleaseNotesCategory(item)) {
releaseNotes.push(item);
...
function sortSidebarItems(items, sortBySemver = false) {
let result = items.map((item) => {
if (item.type === "category") {
- if (itemLabel(item) === "release notes") {
+ if (isReleaseNotesCategory(item)) {
return { ...item, items: sortSidebarItems(item.items, true) };
} else {
return { ...item, items: sortSidebarItems(item.items, false) };
}Also applies to: 47-49, 77-77
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@sidebar-semver-sort.js` around lines 23 - 33, The regrouping relies on
locale-specific item.label text; replace those direct label comparisons in
itemLabel and groupReleaseReferencesUnderUpdatingUnraid (and the other
comparison sites around the earlier checks at the other locations) with a
stable-identifier-first check: implement a helper (e.g., stableIdentifier(item))
that returns one of item.link?.id || item.id || item.customProps?.id (or any
canonical id field your sidebar items expose) and only falls back to
item.label?.toLowerCase() when no stable id exists, then use that helper in the
category/name comparisons so localized labels no longer break the regroup/sort
logic.
Contributor
|
Note Autofix is a beta feature. Expect some limitations and changes as we gather feedback and continue to improve it. The branch was updated while autofix was in progress. Please try again. |
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/unraid-os/updating-unraid/release-types.mdx (1)
90-92: Consider reducing repetition in the decision bullets.These three bullets start with “Use,” which reads repetitive. A small wording variation would improve scanability.
Optional wording tweak
-- Use **Stable** for production systems, important data, remote servers, and systems you do not want to troubleshoot. -- Use **RC** when you want to validate the next stable release and can handle pre-release risk. -- Use **Beta** when you want early access to new work and are prepared to test, report issues, and potentially roll back. +- Choose **Stable** for production systems, important data, remote servers, and systems you do not want to troubleshoot. +- Pick **RC** to validate the next stable release when you can handle pre-release risk. +- Choose **Beta** for early access when you are prepared to test, report issues, and potentially roll back.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/unraid-os/updating-unraid/release-types.mdx` around lines 90 - 92, The three decision bullets that currently begin with "Use" ("Use **Stable**...", "Use **RC**...", "Use **Beta**...") are repetitive; update those three lines to vary the lead verbs for better scanability—for example, "Choose **Stable** for production...", "Select **RC** to validate the next stable release...", and "Opt for **Beta** when you want early access..."—making sure the meaning stays the same and the bolded release names (**Stable**, **RC**, **Beta**) remain unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/unraid-os/updating-unraid/release-types.mdx`:
- Around line 90-92: The three decision bullets that currently begin with "Use"
("Use **Stable**...", "Use **RC**...", "Use **Beta**...") are repetitive; update
those three lines to vary the lead verbs for better scanability—for example,
"Choose **Stable** for production...", "Select **RC** to validate the next
stable release...", and "Opt for **Beta** when you want early access..."—making
sure the meaning stays the same and the bolded release names (**Stable**,
**RC**, **Beta**) remain unchanged.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 6c32ace9-1902-4c2a-8fbc-81c7fb8fc725
📒 Files selected for processing (3)
docs/unraid-os/download_list.mdxdocs/unraid-os/updating-unraid/partials/upgrade-modern.mdxdocs/unraid-os/updating-unraid/release-types.mdx
✅ Files skipped from review due to trivial changes (1)
- docs/unraid-os/download_list.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/unraid-os/updating-unraid/partials/upgrade-modern.mdx
- Purpose: Make it clear where users should report bugs and request features. - Before: Release type guidance only linked to the pre-release feedback board and the footer did not expose the Product Unraid tracker. - Problem: Users with stable-release bugs or feature ideas lacked a direct path from the docs to the right tracker. - New behavior: The release-types page links stable bug reports, pre-release feedback, and feature requests, while the footer includes one compact Feature and Bug Tracker link. - Implementation: Updated the reporting section in release-types.mdx and added a Product Unraid link under the Community footer group.
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (2)
docs/unraid-os/updating-unraid/release-types.mdx (2)
90-93: Optional readability polish in parallel bulletsThese bullets start with very similar phrasing (“Use ...”), which is what LanguageTool flagged. Consider varying sentence openings slightly to reduce repetitive rhythm.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/unraid-os/updating-unraid/release-types.mdx` around lines 90 - 93, Vary the opening phrasing of the four bullets that currently all begin with "Use ..." to improve readability: rephrase the first three bullets referencing the release types "Stable", "RC", and "Beta" so each starts differently (e.g., start with intent or recommendation like "For production systems, choose Stable", "When validating the next release, opt for RC", "If you want early access, select Beta") and keep the last bullet as a clear instruction about not remaining on old pre-releases; ensure the terms "Stable", "RC", and "Beta" remain emphasized.
109-113: Optional: diversify adjacent bullet lead-insThe three consecutive “For ...” bullets read a bit repetitive. Small phrasing variation would improve flow without changing meaning.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/unraid-os/updating-unraid/release-types.mdx` around lines 109 - 113, The three adjacent bullets all begin with the same lead-in ("For ..."), which feels repetitive; update the three lines beginning with "For stable release bugs, use", "For beta or RC feedback, use", and "For product ideas and enhancements, use" to vary the lead-ins while preserving meaning (e.g., "Report stable release bugs at…", "Submit beta/RC feedback to…", "Suggest product ideas and enhancements via…") so the list reads more smoothly without changing the linked destinations.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/unraid-os/updating-unraid/release-types.mdx`:
- Around line 90-93: Vary the opening phrasing of the four bullets that
currently all begin with "Use ..." to improve readability: rephrase the first
three bullets referencing the release types "Stable", "RC", and "Beta" so each
starts differently (e.g., start with intent or recommendation like "For
production systems, choose Stable", "When validating the next release, opt for
RC", "If you want early access, select Beta") and keep the last bullet as a
clear instruction about not remaining on old pre-releases; ensure the terms
"Stable", "RC", and "Beta" remain emphasized.
- Around line 109-113: The three adjacent bullets all begin with the same
lead-in ("For ..."), which feels repetitive; update the three lines beginning
with "For stable release bugs, use", "For beta or RC feedback, use", and "For
product ideas and enhancements, use" to vary the lead-ins while preserving
meaning (e.g., "Report stable release bugs at…", "Submit beta/RC feedback to…",
"Suggest product ideas and enhancements via…") so the list reads more smoothly
without changing the linked destinations.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: db6a7ef1-f00a-471e-b019-cb092f80be59
📒 Files selected for processing (2)
docs/unraid-os/updating-unraid/release-types.mdxdocusaurus.config.ts
🚧 Files skipped from review as they are similar to previous changes (1)
- docusaurus.config.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add Updating Unraid as a root-level Unraid OS category, with a concise landing page for the update journey.
Position Updating Unraid below Troubleshooting in the Unraid OS sidebar, with Release notes and Version history nested under it for navigation.
Keep existing Release notes and Version history document paths in place, so their URLs do not change.
Move Release types and Upgrading Unraid under that root-level update category, including their update/downgrade partials.
Keep detailed upgrade, downgrade, and manual recovery steps on Upgrading Unraid instead of overloading the root landing page.
Keep boot-device replacement under System administration > Maintenance so maintenance is separate from OS update decision-making.
Link the update journey from Version history and update release-note references to the new update path.
Add redirects from the old
system-administration/maintain-and-updateupdate URLs to the newupdating-unraidURLs.Tighten prerelease guidance so users do not remain on old beta or RC builds once newer prerelease or stable options are available.
Clarify Release types so Stable covers both
.0minor releases and later patch releases, including what Unraid minor and patch releases typically contain.Clarify that release branch changes happen in the Unraid account app; the Update OS tool only shows updates for the server's current branch.
Rename Version history to Version Archive and point users toward the built-in updater or USB Creator before browsing archived downloads.
Add Product Unraid links for stable bug reports, pre-release feedback, and feature requests, plus one footer link to the Feature and Bug Tracker.
Why
Updating Unraid is a core lifecycle task, not just a system-administration maintenance task. The docs now present it as a first-class user journey: choose the right release, understand prerelease risk, run the update, find older versions, and troubleshoot if needed.
Separating boot-device replacement into Maintenance keeps hardware/configuration maintenance distinct from OS update guidance. Nesting Release notes and Version history under Updating Unraid keeps the full update flow together in the sidebar without forcing release-note URL changes.
Validation
node -e 'const { sortSidebarItems } = require("./sidebar-semver-sort.js"); const items = [{type:"category",label:"Updating Unraid",items:[{type:"doc",id:"unraid-os/updating-unraid/index"}]},{type:"category",label:"Release notes",items:[{type:"doc",id:"unraid-os/release-notes/7.3.0"},{type:"doc",id:"unraid-os/release-notes/7.2.5"}]},{type:"doc",id:"unraid-os/download_list",label:"Version history"}]; console.log(JSON.stringify(sortSidebarItems(items), null, 2));'\n-pnpm exec remark docs/unraid-os/updating-unraid/index.mdx --quiet --frail\n-pnpm exec remark docs/unraid-os/updating-unraid/index.mdx docs/unraid-os/updating-unraid/release-types.mdx docs/unraid-os/updating-unraid/upgrading-unraid.mdx docs/unraid-os/updating-unraid/partials/manual-downgrade-command-line.mdx docs/unraid-os/updating-unraid/partials/manual-downgrade-simplest.mdx docs/unraid-os/updating-unraid/partials/upgrade-legacy-611-612.mdx docs/unraid-os/updating-unraid/partials/upgrade-modern.mdx docs/unraid-os/download_list.mdx docs/unraid-os/release-notes/7.2.0.md docs/unraid-os/release-notes/7.2.1.md docs/unraid-os/release-notes/7.2.2.md docs/unraid-os/release-notes/7.2.3.md docs/unraid-os/release-notes/7.2.4.md docs/unraid-os/release-notes/7.2.5.md docs/unraid-os/release-notes/7.3.0.md docs/unraid-os/using-unraid-to/run-docker-containers/community-applications.mdx --quiet --frail\n-pnpm exec remark docs/unraid-os/download_list.mdx --quiet --frail\n-pnpm run check-case-sensitivity\n-git diff --check\n\n-git diff --check -- docs/unraid-os/updating-unraid/release-types.mdxpnpm exec remark docs/unraid-os/updating-unraid/release-types.mdx docs/unraid-os/updating-unraid/partials/upgrade-modern.mdx --quiet --frailgit diff --check -- docs/unraid-os/download_list.mdxpnpm exec remark docs/unraid-os/updating-unraid/release-types.mdx --quiet --frailpnpm exec prettier --check docusaurus.config.tsgit diff --check -- docs/unraid-os/updating-unraid/release-types.mdx docusaurus.config.tsPer repo guidance, I did not run the full Docusaurus build.
Summary by CodeRabbit