Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
45ee720
docs: enhance documentation with comprehensive content expansions and…
Oct 14, 2025
4bb42ed
Merge branch 'main' of https://github.com/unraid/docs
Oct 14, 2025
ba26e71
Merge branch 'main' of https://github.com/unraid/docs
Oct 14, 2025
55a491e
docs: apply CodeRabbit formatting and clarity improvements
Oct 15, 2025
f09af34
docs: fix VM snapshot memory dump guidance (CodeRabbit)
Oct 15, 2025
8c00d78
Merge remote-tracking branch 'upstream/main'
Oct 15, 2025
c5d59fe
docs: Fix VM paths, icon organization, and rebuild instructions
Oct 24, 2025
d8ce64c
docs: Organize notification agent icons in dedicated static directory
Oct 24, 2025
b35b7ac
Merge remote-tracking branch 'upstream/main'
Oct 28, 2025
41581ba
docs: Flatten tabbed content and improve documentation accessibility
Oct 31, 2025
9c55e3f
refactor: update sidebar sorting and improve documentation clarity
Oct 31, 2025
393e605
fix: update iframe attributes to JSX camelCase format
Oct 31, 2025
52f84c7
Merge upstream/main: resolve conflicts in release notes and documenta…
Oct 31, 2025
914b829
Merge upstream/main: sync with 7.2.0 release notes update
Oct 31, 2025
28bf859
docs: Update FAQ structure and table of contents settings
Oct 31, 2025
122f77d
docs: Update FAQ and Licensing FAQ for improved structure and accessi…
Oct 31, 2025
3a63f3a
Merge branch 'main' of https://github.com/grizzlechips/docs
Oct 31, 2025
ccb57e8
Merge upstream/main: Bring in Unraid Account section and latest changes
Nov 4, 2025
d582a4b
chore: update documentation for API and configuration improvements
Nov 7, 2025
5e539e5
fix: update documentation and image paths for ZFS storage
Nov 7, 2025
47b247f
fix: update image paths in ZFS storage documentation
Nov 7, 2025
9f89784
fix: update release notes for Unraid OS 7.2.0
Nov 7, 2025
3f0fc6b
fix: update Docusaurus configuration and release notes formatting
Nov 7, 2025
62f14f5
Merge branch 'main' into main
ljm42 Nov 8, 2025
fd459fa
Update documentation for Unraid OS settings and features
Dec 20, 2025
a72fcac
Update ZFS storage documentation image reference
Dec 20, 2025
0a56ce3
Update documentation and configuration files
Jan 8, 2026
c74cfe8
Merge branch 'main' of https://github.com/grizzlechips/docs
Jan 21, 2026
fb1bd15
Refactor docusaurus.config.ts structure and update licensing FAQ docu…
Jan 22, 2026
3e7f0ea
Refactor markdown configuration in docusaurus.config.ts
Jan 22, 2026
fd3db67
Refactor markdown configuration in docusaurus.config.ts
Jan 22, 2026
162251a
feat: add initial guides page
elibosley Feb 9, 2026
e70e5e3
Merge PR 405: add initial guides section
Feb 10, 2026
43033cf
feat: Community App Guides section with Paperless NGX dummy page
Feb 13, 2026
5a9e196
Merge branch 'main' into community-app-guides
grizzlechips Feb 13, 2026
227f856
Merge branch 'main' into community-app-guides
elibosley Feb 24, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 33 additions & 15 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,22 @@ const lightCodeTheme = themes.github;
const darkCodeTheme = themes.dracula;
const DEFAULT_LOCALE = "en";

function createEditUrl({
locale,
versionDocsDirPath,
docPath,
}: {
locale: string;
versionDocsDirPath: string;
docPath: string;
}): string {
if (locale !== DEFAULT_LOCALE) {
return `https://translate.unraid.net/unraid-docs/${locale}`;
}
const branch = process.env.GITHUB_BRANCH || "main";
return `https://github.com/unraid/docs/edit/${branch}/${versionDocsDirPath}/${docPath}`;
}
Comment on lines +32 to +46
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

# First, let's examine the docusaurus.config.ts file to see the actual code
head -350 docusaurus.config.ts | tail -320

Repository: unraid/docs

Length of output: 10987


🏁 Script executed:

# Let's also check the exact content around the lines mentioned
cat -n docusaurus.config.ts | sed -n '30,50p'

Repository: unraid/docs

Length of output: 720


🏁 Script executed:

# Check the guides plugin definition around line 269-278
cat -n docusaurus.config.ts | sed -n '260,290p'

Repository: unraid/docs

Length of output: 1107


🏁 Script executed:

# Let's search for where createEditUrl is used
rg "createEditUrl" docusaurus.config.ts -n

Repository: unraid/docs

Length of output: 155


🌐 Web query:

Docusaurus v3.9.2 EditUrlFunction type signature return value

💡 Result:

In Docusaurus v3.9.2, EditUrlFunction is typed to return either a string edit URL or undefined (to disable the edit link for that specific doc):

type EditUrlFunction = (params: {
  version: string;
  versionDocsDirPath: string;
  docPath: string;
  permalink: string;
  locale: string;
}) => string | undefined;

[1]


createEditUrl return type prevents suppressing edit links for guides in non-default locales

Docusaurus v3.9.2's EditUrlFunction signature returns string | undefined — returning undefined suppresses the "Edit this page" button entirely. The current return type string prevents this.

Since createEditUrl is shared by both the main docs preset and the guides plugin, every non-default-locale page in /guides/ will show an edit link pointing to https://translate.unraid.net/unraid-docs/${locale} — a page unrelated to community guides if they aren't on the translation platform.

Change the return type to string | undefined and return undefined for the guides plugin in non-default locales (or conditionally based on versionDocsDirPath === "guides").

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docusaurus.config.ts` around lines 32 - 46, The createEditUrl function
currently returns string; change its return type to string | undefined and
update its logic so that when locale !== DEFAULT_LOCALE and versionDocsDirPath
=== "guides" (or otherwise identifying guides pages) it returns undefined to
suppress the edit link for non-default-locale guides; keep existing behavior for
other docs (return translate URL for non-default locale when not guides, and the
GitHub edit URL using branch/process.env.GITHUB_BRANCH, versionDocsDirPath,
docPath for default locale).


const config: Config = {
title: "Unraid Docs",
tagline: "Unraid Documentation",
Expand All @@ -49,14 +65,10 @@ const config: Config = {
projectName: "docs", // Usually your repo name.

onBrokenLinks: "warn",
onBrokenMarkdownLinks: "warn",
// Even if you don't use internalization, you can use this field to set useful
// metadata like html lang. For example, if your site is Chinese, you may want
// to replace "en" with "zh-Hans".
markdown: {
hooks: {
onBrokenMarkdownLinks: () => "warn",
},
},
i18n: {
defaultLocale: DEFAULT_LOCALE,
locales: ["en", "es", "fr", "de", "zh"],
Expand All @@ -76,16 +88,7 @@ const config: Config = {
sidebarPath: "./sidebars.js",
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl: ({ locale, versionDocsDirPath, docPath }) => {
// Link to Crowdin for non-English docs
if (locale !== DEFAULT_LOCALE) {
return `https://translate.unraid.net/unraid-docs/${locale}`;
}
// Link to GitHub for English docs
// Use PR branch if available, otherwise default to main
const branch = process.env.GITHUB_BRANCH || "main";
return `https://github.com/unraid/docs/edit/${branch}/${versionDocsDirPath}/${docPath}`;
},
editUrl: createEditUrl,
editLocalizedFiles: true,
async sidebarItemsGenerator({
defaultSidebarItemsGenerator,
Expand Down Expand Up @@ -178,6 +181,11 @@ const config: Config = {
style: { width: "30px" },
},
items: [
{
to: "/guides/",
label: "Community App Guides",
position: "left",
},
{
items: [
{ href: "https://unraid.net", label: "Unraid Home" },
Expand Down Expand Up @@ -258,6 +266,16 @@ const config: Config = {

plugins: [
"docusaurus-plugin-image-zoom",
[
"@docusaurus/plugin-content-docs",
{
id: "guides",
path: "guides",
routeBasePath: "guides",
sidebarPath: "./sidebarsGuides.js",
editUrl: createEditUrl,
},
],
[
"@docusaurus/plugin-ideal-image",
{
Expand Down
18 changes: 18 additions & 0 deletions guides/intro.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
sidebar_position: 1
title: About these guides
slug: /
---

This section contains step-by-step tutorials and how-to guides for third-party and community applications that run on Unraid. It is maintained separately from the main Unraid documentation.

These guides provide general setup steps for common self-hosted applications; however, we strongly recommend reviewing each application's official documentation for detailed support and troubleshooting.

There is no guarantee that every guide will remain current. However, for popular guides, we may dedicate resources to update them to the best of our ability.

## Contributing to or using a guide

- Each guide **must** include a "Last validated [date]" note indicating when the steps were last reviewed.
- If you notice that a guide is out of date, you can suggest changes via pull requests or report issues in the repository so the community can help keep useful guides current.

More guides will be added over time. If you have a guide you'd like to submit, see the [main documentation repository](https://github.com/unraid/docs) for contribution guidelines.
15 changes: 15 additions & 0 deletions guides/paperless-ngx.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
sidebar_position: 2
title: Paperless NGX
description: Paperless NGX on Unraid
---

:::info[Last validated]

*[Date to be filled when real content is added]*

:::

## Paperless NGX on Unraid

This is a placeholder page for the Paperless NGX guide. It demonstrates how a guide appears in the Community App Guides section alongside the rest of the site.
6 changes: 6 additions & 0 deletions sidebarsGuides.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
guidesSidebar: [{ type: 'autogenerated', dirName: '.' }],
};

module.exports = sidebars;