chore(unraid): sync unraid template with README#417
Conversation
📝 WalkthroughWalkthroughUpdated the Unraid template file to align with current project documentation and container structure. Changes include refreshed Discord community link, revised overview text, updated support reference link, adjusted Book Library mount path, and added optional API documentation configuration variable. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested labels
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
✨ Simplify code
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 |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
unraid.xml (1)
38-38: New configuration variable not mentioned in PR objectives.The addition of
API_DOCS_ENABLEDis valid and aligns with the backend configuration inapplication.yamland theScalarController. However, this change wasn't mentioned in the PR description or linked issue#416.Consider:
- Updating the PR description to document this addition.
- Adding corresponding documentation in grimmory-docs, since the linked repository research found no references to
API_DOCS_ENABLEDin the docs repo.,
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@unraid.xml` at line 38, Add a note to the PR description and link issue `#416` stating that a new config variable API_DOCS_ENABLED was added (it maps to the backend setting in application.yaml and is consumed by ScalarController) and create/submit a short documentation entry in the grimmory-docs repo describing the config key, default value (false), purpose (enable public API docs/OpenAPI JSON), and where to change it so users know how to enable the feature; reference API_DOCS_ENABLED, application.yaml, and ScalarController in both the PR description and the docs entry.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@unraid.xml`:
- Line 38: Add a note to the PR description and link issue `#416` stating that a
new config variable API_DOCS_ENABLED was added (it maps to the backend setting
in application.yaml and is consumed by ScalarController) and create/submit a
short documentation entry in the grimmory-docs repo describing the config key,
default value (false), purpose (enable public API docs/OpenAPI JSON), and where
to change it so users know how to enable the feature; reference
API_DOCS_ENABLED, application.yaml, and ScalarController in both the PR
description and the docs entry.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: ff234b43-9acd-4e59-9afc-2851631c99e3
📒 Files selected for processing (1)
unraid.xml
📜 Review details
⏰ 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). (3)
- GitHub Check: Test Suite / Frontend Tests
- GitHub Check: Test Suite / Backend Tests
- GitHub Check: Analyze (java-kotlin)
🧰 Additional context used
🔀 Multi-repo context grimmory-tools/grimmory-docs
Linked repositories findings
grimmory-tools/grimmory-docs [::grimmory-tools/grimmory-docs::]
-
Library mount path: docs/getting-started.md, docs/installation.md and multiple auth docs reference ./books:/books and /books as the canonical library mount (e.g., docs/getting-started.md:30, docs/installation.md:27, docs/authentication/oidc-settings.md:358/435). This matches the PR change from /data/media/books → /books. [::grimmory-tools/grimmory-docs::]
-
Discord invite: the site header and CTA link to the Discord invite https://discord.gg/vNsB8CTebs in src/pages/HomepageHeader.tsx and src/pages/CallToAction.tsx, and docs/getting-started.md lists the same invite. The PR updates the unraid template Discord invite — verify the new invite matches these files. [::grimmory-tools/grimmory-docs::]
-
API docs / OpenAPI flag: no occurrences of API_DOCS_ENABLED, API_DOCS, openapi, or /openapi.json were found in the repo search output. There is no evidence the docs site exposes or documents a public OpenAPI JSON endpoint to be toggled by API_DOCS_ENABLED. (Search for "API_DOCS_ENABLED|API_DOCS|openapi|OpenAPI|/openapi.json|/docs" returned no matches.) [::grimmory-tools/grimmory-docs::]
Notes / impact:
- The unraid.xml change to use /books aligns with existing docs; no further docs updates appear necessary.
- Confirm the Discord invite in the PR equals vNsB8CTebs (or update docs/src pages if the invite changed).
- The new API_DOCS_ENABLED variable appears not to be referenced in this docs repo — if enabling public API docs requires documentation, add docs pages or mention in installation/getting-started as needed. [::grimmory-tools/grimmory-docs::]
🔇 Additional comments (4)
unraid.xml (4)
13-13: LGTM!Overview text update aligns with PR objectives for branding refresh.
30-30: LGTM!The setup guidance link now points to the getting-started docs as specified in the PR objectives.
33-33: LGTM!The mount target path change from
/data/media/booksto/booksaligns with the canonical library mount documented in grimmory-docs (docs/getting-started.md,docs/installation.md, etc.).
11-11: The Discord invite9YJ7HB4n8Tin this PR is consistent with the rest of the grimmory repository (README.md, CONTRIBUTING.md). However, the grimmory-docs repository currently references a different invite (vNsB8CTebs). Both invites are valid. If maintaining a single Discord server across both repositories is intended, the docs repository should be updated separately to align.
Description
This PR updates the Unraid template to reflect the current README and runtime defaults.
Linked Issue: Fixes #416
Changes
grimmory.org/docs/getting-started)Summary by CodeRabbit
New Features
Configuration Changes
Documentation