docs(truenas): update install/migration guide

[M0NsTeRRR]

Description

docs(truenas): update install/migration guide

I haven’t tested the guide myself, but some Discord users have reported that it works.

based on : truenas/apps#3374 (comment)
based on : truenas/apps#3374 (comment)

Also fixed

[WARNING] The `siteConfig.onBrokenMarkdownLinks` config option is deprecated and will be removed in Docusaurus v4.

How Has This Been Tested?

Screenshots / Logs (if applicable)

Host path

ixVolume

Checklist:

• I have read and followed the contribution guidelines.
• Disclosed any use of AI (see our policy)
• I have updated the documentation accordingly.
• All new and existing tests passed.
• Successful build pnpm build
• Translation keys pnpm i18n:extract
• Database migration (if required)

Summary by CodeRabbit

• Documentation
  • Replaced deprecated/work-in-progress warnings with a concise Install section for TrueNAS, giving step-by-step app discovery and install instructions.
  • Expanded the migration guide with two clear migration paths and a detailed Unraid migration flow including example commands and paths.
  • Adjusted documentation configuration to retain the broken-markdown-links behavior while relocating its setting for improved Markdown link handling.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

---

📝 Walkthrough

Walkthrough

Removed WIP/deprecation warnings from TrueNAS docs and added a concise Install section; expanded migration-guide with tabbed Host Path and ixVolume migration flows and updated Unraid migration steps; moved onBrokenMarkdownLinks: 'warn' into markdown.hooks in Docusaurus config.

Changes

Cohort / File(s)	Summary
TrueNAS Install docs/getting-started/third-parties/truenas.mdx	Removed deprecated/WIP warnings and related comments; added a concise Install section with steps: Apps → Discover Apps → search "Seerr" → install.
Migration Guide (TrueNAS & Unraid) docs/migration-guide.mdx	Replaced placeholder text with a Tabs block offering two migration paths (Host Path and ixVolume) including dataset/path examples and rsync guidance; expanded Unraid migration steps and updated formatting.
Docusaurus Config gen-docs/docusaurus.config.ts	Moved onBrokenMarkdownLinks: 'warn' from top-level config into the markdown.hooks configuration without changing its value.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• docs: fix migration guide title #2425: Edits to docs/migration-guide.mdx that may overlap with the new tabbed migration content.
• docs: add Unraid installation and migration guide #2440: Updates to Unraid installation/migration docs likely touching the same Unraid guidance.
• docs(unraid): improve unraid migration guide  #2470: Unraid migration and permissions guidance (UID:GID and appdata ownership) that intersects with these Unraid instructions.

Suggested reviewers

• fallenbagel
• gauthier-th

Poem

🐰 hop-hop through the docs I tread,
I trim the WIP and stitch the thread.
Two tidy paths and config moved,
A cheerful guide, all steps approved.
Hooray — install, migrate, groove! 🥕✨

🚥 Pre-merge checks | ✅ 2

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title 'docs(truenas): update install/migration guide' directly and specifically describes the main changes: updates to TrueNAS documentation covering both installation and migration guides.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

🧹 Nitpick comments (2)

docs/migration-guide.mdx (1)

240-243: The rsync source path assumes Jellyseerr; Overseerr users may need a different path.

The rsync command hardcodes /mnt/.ix-apps/app_mounts/jellyseerr/ as the source. Users migrating from Overseerr may have their data at a different path (e.g., /mnt/.ix-apps/app_mounts/overseerr/). Consider adding a note to adjust the path accordingly.

📝 Suggested clarification

     3. Copy ixVolume Data
         Open System Settings → Shell, or SSH into your TrueNAS server as root and run :
         ```
-        rsync -av /mnt/.ix-apps/app_mounts/jellyseerr/ /mnt/storage/seerr/
+        rsync -av /mnt/.ix-apps/app_mounts/<app-name>/ /mnt/storage/seerr/
         ```
+        Replace `<app-name>` with `jellyseerr` or `overseerr` depending on your current installation.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/migration-guide.mdx` around lines 240 - 243, The docs currently hardcode
the rsync source as /mnt/.ix-apps/app_mounts/jellyseerr/ which is incorrect for
Overseerr users; update the migration example in migration-guide.mdx to use a
placeholder (e.g., /mnt/.ix-apps/app_mounts/<app-name>/) and add a brief note
instructing readers to replace <app-name> with jellyseerr or overseerr (or their
actual app folder) so the rsync command works for both installations.

docs/getting-started/third-parties/truenas.mdx (1)

19-22: Install section provides guidance despite WIP warning.

The danger block at lines 7-10 states this method "has not yet been updated for Seerr and is currently a work in progress," yet this new Install section provides concrete instructions. Consider either:

1. Updating the danger block to reflect that basic installation works but may have issues, or
2. Adding a note that these are preliminary instructions pending the linked issue resolution.

This will help users understand what to expect.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/getting-started/third-parties/truenas.mdx` around lines 19 - 22, The new
"## Install" section gives concrete steps for installing Seerr but contradicts
the earlier danger block that marks the method as WIP; update the danger block
near the top of the file or add a short inline note inside the "## Install"
section to clarify these are preliminary instructions (e.g., "preliminary — may
have issues; see linked issue") so readers know the install steps (Apps menu →
Discover Apps → search 'Seerr') are provisional until the linked issue is
resolved; modify either the existing danger block text or insert a brief caveat
at the start of the "## Install" section to resolve the inconsistency.

🤖 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/getting-started/third-parties/truenas.mdx`:
- Around line 19-22: The new "## Install" section gives concrete steps for
installing Seerr but contradicts the earlier danger block that marks the method
as WIP; update the danger block near the top of the file or add a short inline
note inside the "## Install" section to clarify these are preliminary
instructions (e.g., "preliminary — may have issues; see linked issue") so
readers know the install steps (Apps menu → Discover Apps → search 'Seerr') are
provisional until the linked issue is resolved; modify either the existing
danger block text or insert a brief caveat at the start of the "## Install"
section to resolve the inconsistency.

In `@docs/migration-guide.mdx`:
- Around line 240-243: The docs currently hardcode the rsync source as
/mnt/.ix-apps/app_mounts/jellyseerr/ which is incorrect for Overseerr users;
update the migration example in migration-guide.mdx to use a placeholder (e.g.,
/mnt/.ix-apps/app_mounts/<app-name>/) and add a brief note instructing readers
to replace <app-name> with jellyseerr or overseerr (or their actual app folder)
so the rsync command works for both installations.

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/migration-guide.mdx`:
- Around line 213-248: The TabItem values/labels are swapped relative to their
content: the TabItem with value="ixvolume" currently contains Host Path
migration steps and the TabItem with value="hostpath" contains ixVolume steps;
update the two TabItem elements (the ones with value="ixvolume" and
value="hostpath") so their value and label match the described content (swap the
labels and/or values so the "Host Path" label/value wraps the Host Path
migration steps and the "ixVolume" label/value wraps the ixVolume migration
steps).

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/migration-guide.mdx`:
- Around line 223-245: The rsync example hardcodes "jellyseerr" and copies to
/mnt/storage/seerr/ which conflicts with Step 4's host path
/mnt/storage/seerr/config; update the rsync line (the block under "3. Copy
ixVolume Data") to use a placeholder like /mnt/.ix-apps/app_mounts/<app-name>/
and make the destination include the config subfolder
(/mnt/storage/<app-name>/config/) or alternatively change the Step 4 host path
to match the current rsync destination; also add a short note: "Replace
<app-name> with jellyseerr or overseerr as appropriate." Reference the rsync
command and Step 4 host path when making edits.

[gauthier-th]

Looks like you inverted both?

[M0NsTeRRR]

Yes, I fixed it after CoderabbitAI reported it to me, but I didn’t refresh the screenshots.

[Copilot]

Pull request overview

This pull request updates the TrueNAS installation and migration documentation based on community feedback from Discord users. The changes remove the work-in-progress warnings and add concrete installation and migration instructions for TrueNAS users. The PR also attempts to address a deprecated Docusaurus configuration warning.

Changes:

• Added installation instructions for TrueNAS in the third-party documentation
• Created comprehensive migration guide for TrueNAS with two migration paths (Host Path and ixVolume)
• Attempted to fix deprecated onBrokenMarkdownLinks configuration in Docusaurus

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 6 comments.

File	Description
gen-docs/docusaurus.config.ts	Attempts to move deprecated onBrokenMarkdownLinks config to new location (contains error)
docs/migration-guide.mdx	Adds detailed TrueNAS migration instructions with Host Path and ixVolume migration paths
docs/getting-started/third-parties/truenas.mdx	Removes work-in-progress warning and adds basic installation instructions

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.