Skip to content

Conversation

@elibosley
Copy link
Member

@elibosley elibosley commented Feb 9, 2026

Before Submitting This PR, Please Ensure You Have Completed The Following:

  1. Are internal links to wiki documents using relative file links?
  2. Are all new documentation files lowercase, with dash separated names (ex. unraid-os.mdx)?
  3. Are all assets (images, etc), located in an assets/ subfolder next to the .md/mdx files?
  4. Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  5. Is the build succeeding?

Summary by CodeRabbit

  • New Features
    • Added a new "Guides" section with a dedicated link in the top navigation bar
    • Introduced introductory documentation to help users discover resources and get started
    • Implemented automatic sidebar navigation for guides section to improve content organization and browsing

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 9, 2026

📝 Walkthrough

Walkthrough

A new "Guides" documentation section has been added to the site. This includes a navbar navigation link, a dedicated Docusaurus docs plugin configuration for the guides, a sidebar configuration file, and an introductory documentation page.

Changes

Cohort / File(s) Summary
Configuration Setup
docusaurus.config.ts, sidebarsGuides.js
Added navbar link to guides section and configured a new Docusaurus docs plugin instance with autogenerated sidebar, locale-aware edit URLs pointing to GitHub or Crowdin translation pages.
Documentation Content
guides/intro.mdx
New introductory guide page with MDX frontmatter metadata (sidebar position, title, slug) and "Unraid Guides" header content.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 A guides section hops into place,
With navbar links and sidebar grace,
From config tweaks to content new,
The Unraid docs now welcome you!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding an initial guides page to the documentation site.
Description check ✅ Passed The description matches the template exactly, including all five checklist items. However, all items are unchecked, suggesting the author has not verified completion of these requirements.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feat/guides-section

No actionable comments were generated in the recent review. 🎉

🧹 Recent nitpick comments
docusaurus.config.ts (1)

268-283: Consider adding remarkPlugins for consistency with main docs.

The guides plugin is missing the remarkPlugins configuration that the main docs preset includes (auto-glossary, JSX spacing, lint rules). This could lead to inconsistent content processing between the main docs and guides sections.

If guides should follow the same formatting and glossary conventions, consider extracting the remarkPlugins array to a shared constant and reusing it here.

♻️ Suggested approach
+// At the top of the file, extract shared remark plugins
+const sharedRemarkPlugins = [
+  [remarkAutoGlossary, { yamlFile: "glossary.yaml" }],
+  jsxContentSpacing,
+  remarkPresetLintRecommended,
+  // ... other plugins
+];

// Then in both the preset docs and the guides plugin:
-        remarkPlugins: [
-          [remarkAutoGlossary, { yamlFile: "glossary.yaml" }],
-          // ...
-        ],
+        remarkPlugins: sharedRemarkPlugins,

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

@github-actions
Copy link
Contributor

github-actions bot commented Feb 9, 2026

PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://unraid.github.io/docs/pr-preview/pr-405/

Built to branch gh-pages at 2026-02-09 21:39 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant