feat(settings): add help tooltips for services setup#2662
feat(settings): add help tooltips for services setup#2662
Conversation
📝 WalkthroughWalkthroughAdds 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
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 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 |
There was a problem hiding this comment.
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
📒 Files selected for processing (4)
src/components/Settings/RadarrModal/index.tsxsrc/components/Settings/SonarrModal/index.tsxsrc/components/Setup/JellyfinSetup.tsxsrc/i18n/locale/en.json
There was a problem hiding this comment.
🧹 Nitpick comments (1)
src/components/Settings/SonarrModal/index.tsx (1)
402-404: Consider UI consistency with JellyfinSetup's tooltip pattern.The inline
label-tippattern used here (text always visible) differs from JellyfinSetup's hover-basedTooltipwithInformationCircleIcon. 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
📒 Files selected for processing (4)
src/components/Settings/RadarrModal/index.tsxsrc/components/Settings/SonarrModal/index.tsxsrc/components/Setup/JellyfinSetup.tsxsrc/i18n/locale/en.json
🚧 Files skipped from review as they are similar to previous changes (1)
- src/components/Settings/RadarrModal/index.tsx
Description
Add help texts for *arr services setup + Jellyfin (URL Base).
How Has This Been Tested?
Screenshots / Logs (if applicable)
Checklist:
pnpm buildpnpm i18n:extractSummary by CodeRabbit
New Features
Documentation