docs(nixpkgs): add documentation for nixpkgs 26.05#3089
Conversation
M0NsTeRRR
changed the title
📝 WalkthroughWalkthroughThis PR updates Nix documentation to state Seerr is available as of NixOS 26.05, adjusts the getting-started admonition, and removes an HTML comment so the VersionMismatchWarning component renders before the Installation section. ChangesNix Documentation Release Status
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 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
🧹 Nitpick comments (2)
docs/migration-guide.mdx (1)
225-225: 💤 Low valueEnsure consistent wording with getting-started/nixpkg.mdx.
This line uses identical wording to line 15 in
docs/getting-started/nixpkg.mdx. If you adjust the phrasing there to clarify release timing (as suggested in that file's review), apply the same change here for consistency.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/migration-guide.mdx` at line 225, Update the sentence "The Seerr service and package are available as of the 26.05 release." in docs/migration-guide.mdx to match the revised phrasing you applied to docs/getting-started/nixpkg.mdx (ensure identical wording and tense, e.g., clarify release timing or use "released in 26.05" if that's the change). Locate the exact sentence in migration-guide.mdx and replace it with the same corrected sentence used in nixpkg.mdx so both files remain consistent.docs/getting-started/nixpkg.mdx (1)
15-15: 💤 Low valueConsider clarifying the release timing.
The phrasing "as of the 26.05 release" could be ambiguous since the PR is blocked until the release completes (2026-05-30 07:00 per the PR description). Consider using "starting with" or "beginning with" to make it clearer that this refers to the 26.05 release cycle without implying immediate availability if read before the release.
📝 Alternative phrasing
-The Seerr service and package are available as of the 26.05 release. +The Seerr service and package are available starting with the 26.05 release.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/getting-started/nixpkg.mdx` at line 15, Update the ambiguous phrase "as of the 26.05 release" in the docs/getting-started/nixpkg.mdx to clearer wording such as "starting with the 26.05 release" or "beginning with the 26.05 release" so it clearly indicates inclusion from that release cycle (replace the exact string "as of the 26.05 release" with one of the suggested alternatives).
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/getting-started/nixpkg.mdx`:
- Line 18: The NixOS options link in docs/getting-started/nixpkg.mdx currently
points to https://search.nixos.org/options?channel=unstable&query=seerr which
returns no results; update the URL so the channel and query match the
documentation: change the channel parameter to the intended stable channel
(e.g., channel=26.05) and replace the query value "seerr" with the correct NixOS
option/package name referenced in the doc (the exact package/option string used
elsewhere in the text), ensuring the resulting URL returns the expected search
result.
---
Nitpick comments:
In `@docs/getting-started/nixpkg.mdx`:
- Line 15: Update the ambiguous phrase "as of the 26.05 release" in the
docs/getting-started/nixpkg.mdx to clearer wording such as "starting with the
26.05 release" or "beginning with the 26.05 release" so it clearly indicates
inclusion from that release cycle (replace the exact string "as of the 26.05
release" with one of the suggested alternatives).
In `@docs/migration-guide.mdx`:
- Line 225: Update the sentence "The Seerr service and package are available as
of the 26.05 release." in docs/migration-guide.mdx to match the revised phrasing
you applied to docs/getting-started/nixpkg.mdx (ensure identical wording and
tense, e.g., clarify release timing or use "released in 26.05" if that's the
change). Locate the exact sentence in migration-guide.mdx and replace it with
the same corrected sentence used in nixpkg.mdx so both files remain consistent.
🪄 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: 07c11b0e-8a1f-4125-b691-c3cd3fdeffac
📒 Files selected for processing (2)
docs/getting-started/nixpkg.mdxdocs/migration-guide.mdx
Signed-off-by: Ludovic Ortega <ludovic.ortega@adminafk.fr>
M0NsTeRRR
force-pushed
the
docs/nixos-26.05-release
branch
from
0646403 to
ba39dfe
Compare
1 participant
Description
Add documentation for nixpkgs 26.05
How Has This Been Tested?
n/a
Screenshots / Logs (if applicable)
Tested the warning message by hardcoding
seerrVersion = "1.0.0"instead ofseerrVersion = SeerrVersion();Checklist:
pnpm buildpnpm i18n:extractSummary by CodeRabbit