Skip to content

feat(settings): add help tooltips for services setup#2662

Open
0xSysR3ll wants to merge 2 commits intodevelopfrom
0xsysr3ll/feat/setup-tooltips
Open

feat(settings): add help tooltips for services setup#2662
0xSysR3ll wants to merge 2 commits intodevelopfrom
0xsysr3ll/feat/setup-tooltips

Conversation

@0xSysR3ll
Copy link
Contributor

@0xSysR3ll 0xSysR3ll commented Mar 8, 2026

Description

Add help texts for *arr services setup + Jellyfin (URL Base).

How Has This Been Tested?

Screenshots / Logs (if applicable)

Checklist:

  • I have read and followed the contribution guidelines.
  • Disclosed any use of AI (see our policy)
  • I have updated the documentation accordingly.
  • All new and existing tests passed.
  • Successful build pnpm build
  • Translation keys pnpm i18n:extract
  • Database migration (if required)

Summary by CodeRabbit

  • New Features

    • Added contextual help tooltips across settings (Radarr, Sonarr) and the Jellyfin setup URL Base to clarify server, API key, base URL, external URL, monitoring/sync, and search options.
  • Documentation

    • Added corresponding English localization/help text entries for the new tooltips; no behavior or validation changes.

@0xSysR3ll 0xSysR3ll requested a review from a team as a code owner March 8, 2026 22:01
@coderabbitai
Copy link

coderabbitai bot commented Mar 8, 2026

📝 Walkthrough

Walkthrough

Adds inline contextual help texts to service configuration UIs (Radarr, Sonarr, Jellyfin) and new i18n entries; help messages are rendered as label tooltips/inline tips next to relevant form fields.

Changes

Cohort / File(s) Summary
Radarr Settings Help
src/components/Settings/RadarrModal/index.tsx
Added help message keys (server4kHelp, apiKeyHelp, baseUrlHelp, externalUrlHelp, syncEnabledHelp, enableSearchHelp) and rendered inline label-tip spans beside corresponding labels.
Sonarr Settings Help
src/components/Settings/SonarrModal/index.tsx
Added help message keys (server4kHelp, monitorNewItemsHelp, apiKeyHelp, baseUrlHelp, externalUrlHelp, syncEnabledHelp, enableSearchHelp) and rendered inline label-tip spans beside corresponding labels.
Jellyfin Setup Help
src/components/Setup/JellyfinSetup.tsx
Added urlBaseHelp i18n key and rendered a Tooltip with InformationCircleIcon beside the URL Base label (inline-flex label styling updated).
Localization
src/i18n/locale/en.json
Inserted new English localization strings for the added help keys used by Radarr, Sonarr, Jellyfin, and login URL base help entries.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 I nibble keys and URLs with care,
Little hints tucked in the air.
Labels glow with friendly light,
New users find their path tonight —
Hop on, setup's tidy and fair. ✨

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main change: adding help tooltips across services setup forms (Radarr, Sonarr, Jellyfin) with corresponding i18n keys, which is the core purpose of the PR.
Linked Issues check ✅ Passed The PR fully implements the requested feature from #2535: adding contextual help texts across *arr services (Radarr, Sonarr) and Jellyfin setup forms to guide first-time users, with all UI and i18n additions complete.
Out of Scope Changes check ✅ Passed All changes are scoped to adding help tooltips and their internationalization keys across settings/setup components; no unrelated modifications to validation logic, API handling, or unrelated features detected.

✏️ 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.

❤️ Share

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

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@src/i18n/locale/en.json`:
- Around line 274-275: Add the new translation keys introduced in en.json so
non-English locales don't fall back to English: add components.Login.urlBaseHelp
and the Radarr/Sonarr keys (components.Settings.RadarrModal.apiKeyHelp,
baseUrlHelp, enableSearchHelp, externalUrlHelp, server4kHelp, syncEnabledHelp
and components.Settings.SonarrModal.apiKeyHelp, baseUrlHelp, enableSearchHelp,
externalUrlHelp, monitorNewItemsHelp, server4kHelp, syncEnabledHelp) to every
locale bundle listed (ar.json, bg.json, ca.json, cs.json, da.json, de.json,
el.json, es.json, es_MX.json, eu.json, fi.json, fr.json, he.json, hi.json,
hr.json, hu.json, it.json, ja.json, ko.json, lt.json, nb_NO.json, nl.json,
pl.json, pt_BR.json, pt_PT.json, ro.json, ru.json, sl.json, sq.json, sr.json,
sv.json, tr.json, uk.json, vi.json, zh_Hans.json, zh_Hant.json) using
appropriate translations (or placeholders) for each key so the message IDs exist
in each file and fallback is not required.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b5494fe6-802c-466b-823e-1970618c70ab

📥 Commits

Reviewing files that changed from the base of the PR and between ff4ab21 and 52c77df.

📒 Files selected for processing (4)
  • src/components/Settings/RadarrModal/index.tsx
  • src/components/Settings/SonarrModal/index.tsx
  • src/components/Setup/JellyfinSetup.tsx
  • src/i18n/locale/en.json

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
src/components/Settings/SonarrModal/index.tsx (1)

402-404: Consider UI consistency with JellyfinSetup's tooltip pattern.

The inline label-tip pattern used here (text always visible) differs from JellyfinSetup's hover-based Tooltip with InformationCircleIcon. While this follows the existing pattern in SonarrModal (e.g., tagRequestsInfo), it creates an inconsistent user experience across the application.

This is a minor nitpick since the current implementation is internally consistent within this file. If unified UX is desired, consider refactoring to use the same Tooltip+icon pattern.

Also applies to: 512-514, 538-540

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

In `@src/components/Settings/SonarrModal/index.tsx` around lines 402 - 404, The UI
uses a visible inline "label-tip" text (e.g., the span showing
messages.server4kHelp and other label-tip instances like tagRequestsInfo) which
is inconsistent with JellyfinSetup's hover-based pattern; replace these inline
spans with the same Tooltip + InformationCircleIcon pattern used in
JellyfinSetup (use the Tooltip component and InformationCircleIcon) so the help
text appears on hover and matches the rest of the app—update the occurrences
that render label-tip (including the server4kHelp span and the similar tips at
the other noted occurrences) to use Tooltip wrapping the icon and pass the same
intl.formatMessage(messages.*) content to the Tooltip.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@src/components/Settings/SonarrModal/index.tsx`:
- Around line 402-404: The UI uses a visible inline "label-tip" text (e.g., the
span showing messages.server4kHelp and other label-tip instances like
tagRequestsInfo) which is inconsistent with JellyfinSetup's hover-based pattern;
replace these inline spans with the same Tooltip + InformationCircleIcon pattern
used in JellyfinSetup (use the Tooltip component and InformationCircleIcon) so
the help text appears on hover and matches the rest of the app—update the
occurrences that render label-tip (including the server4kHelp span and the
similar tips at the other noted occurrences) to use Tooltip wrapping the icon
and pass the same intl.formatMessage(messages.*) content to the Tooltip.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: ae523540-bd07-4511-925c-d375d40d5b4b

📥 Commits

Reviewing files that changed from the base of the PR and between 52c77df and 877a6a1.

📒 Files selected for processing (4)
  • src/components/Settings/RadarrModal/index.tsx
  • src/components/Settings/SonarrModal/index.tsx
  • src/components/Setup/JellyfinSetup.tsx
  • src/i18n/locale/en.json
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/components/Settings/RadarrModal/index.tsx

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.

Help-texts in service forms

2 participants