docs: promote Nixpkgs as an official installation method#2775
Open
docs: promote Nixpkgs as an official installation method#2775
Conversation
Signed-off-by: Ludovic Ortega <ludovic.ortega@adminafk.fr>
📝 WalkthroughWalkthroughThis PR reorganizes Nix installation documentation by moving the guide from a third-party folder to the main getting-started section, reorders sidebar navigation positions for related installation pages, updates component URLs to reference new nixpkgs paths, and refreshes migration guide content. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 2✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
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)
gen-docs/src/components/SeerrVersion/index.tsx (1)
74-76:⚠️ Potential issue | 🟡 MinorIncorrect error return type will cause rendering issues.
The error case returns
{ error }(an object) rather than a renderable value. This will display as[object Object]in the UI instead of the actual error message.🐛 Proposed fix
if (error) { - return { error }; + return `Error: ${error}`; }🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@gen-docs/src/components/SeerrVersion/index.tsx` around lines 74 - 76, The error branch in the SeerrVersion component returns an object ({ error }) which will render as "[object Object]"; change the error handling in SeerrVersion to return a renderable value such as a string or JSX that shows the error message (e.g., use error.message or wrap it in a <div> or <span>), ensuring you reference the existing error variable and the SeerrVersion component's return path.
🧹 Nitpick comments (1)
docs/getting-started/nixpkg.mdx (1)
7-10: Unused imports due to commented-out code.
SeerrVersion,NixpkgVersion,Admonition,Tabs, andTabItemare imported but not used because theVersionMismatchWarningcomponent is fully commented out (lines 23-75). This may cause build warnings or linter errors depending on the project configuration.Consider either:
- Removing the unused imports and commented-out code if it's not planned for near-term use
- Uncommenting and enabling the
VersionMismatchWarningfeature if it's ready♻️ Proposed fix to remove unused imports
-import { SeerrVersion, NixpkgVersion } from '@site/src/components/SeerrVersion'; -import Admonition from '@theme/Admonition'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem';And remove lines 23-75 (the commented-out component).
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/getting-started/nixpkg.mdx` around lines 7 - 10, The file imports SeerrVersion, NixpkgVersion, Admonition, Tabs, and TabItem but the VersionMismatchWarning component block is fully commented out, leaving unused imports; either remove those unused imports (SeerrVersion, NixpkgVersion, Admonition, Tabs, TabItem) and delete the commented VersionMismatchWarning block, or restore/uncomment and enable the VersionMismatchWarning component so those imports are used (look for the commented VersionMismatchWarning block and the import statements to adjust accordingly).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@gen-docs/src/components/SeerrVersion/index.tsx`:
- Around line 37-39: The stableUrl constant in the SeerrVersion component points
to a non-existent branch ('nixos-26.05'), causing fetches to 404 and fall back
to "0.0.0"; update the stableUrl value to point to an existing nixpkgs branch
(for example 'nixos-25.11') or add explicit handling in the SeerrVersion fetch
logic to detect a 404 and render a "Not yet released" message instead of
defaulting to "0.0.0" (refer to the stableUrl constant and the SeerrVersion
component's fetch/response handling to implement the change).
---
Outside diff comments:
In `@gen-docs/src/components/SeerrVersion/index.tsx`:
- Around line 74-76: The error branch in the SeerrVersion component returns an
object ({ error }) which will render as "[object Object]"; change the error
handling in SeerrVersion to return a renderable value such as a string or JSX
that shows the error message (e.g., use error.message or wrap it in a <div> or
<span>), ensuring you reference the existing error variable and the SeerrVersion
component's return path.
---
Nitpick comments:
In `@docs/getting-started/nixpkg.mdx`:
- Around line 7-10: The file imports SeerrVersion, NixpkgVersion, Admonition,
Tabs, and TabItem but the VersionMismatchWarning component block is fully
commented out, leaving unused imports; either remove those unused imports
(SeerrVersion, NixpkgVersion, Admonition, Tabs, TabItem) and delete the
commented VersionMismatchWarning block, or restore/uncomment and enable the
VersionMismatchWarning component so those imports are used (look for the
commented VersionMismatchWarning block and the import statements to adjust
accordingly).
🪄 Autofix (Beta)
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: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 9c8aa48f-7452-47ae-a915-c2839fdcbf9a
📒 Files selected for processing (8)
docs/getting-started/nixpkg.mdxdocs/getting-started/third-parties/aur.mdxdocs/getting-started/third-parties/nixpkg.mdxdocs/getting-started/third-parties/synology.mdxdocs/getting-started/third-parties/truenas.mdxdocs/getting-started/third-parties/unraid.mdxdocs/migration-guide.mdxgen-docs/src/components/SeerrVersion/index.tsx
💤 Files with no reviewable changes (1)
- docs/getting-started/third-parties/nixpkg.mdx
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
2 participants
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.
Description
promote Nixpkgs as an official installation method
How Has This Been Tested?
Screenshots / Logs (if applicable)
Checklist:
pnpm buildpnpm i18n:extractSummary by CodeRabbit