docs(settings): improve Metadata settings docs#3140
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughAdds documentation for the Metadata Providers settings page: admins select TheMovieDB or TheTVDB for Series and Anime; the Test button issues one request per configured provider (only if selected for at least one relevant media type), updates provider badges (Operational / Not tested / Failed), and shows an error/toast on failure. ChangesMetadata Providers Settings Documentation
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 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 |
![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
🤖 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/using-seerr/settings/metadata.md`:
- Around line 15-16: The phrase "three status badges" in the sentence that lists
`TheMovieDB` and `TheTVDB` is incorrect; either change "three" to "two" or add
the missing third badge to the list. Update the sentence containing "three
status badges" to match the badges enumerated (`TheMovieDB`, `TheTVDB`) or
include the third badge identifier (e.g., the intended third provider) so the
count and list are 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: 007d6e8c-4ccf-4ff9-980b-829ace866507
📒 Files selected for processing (1)
docs/using-seerr/settings/metadata.md
fallenbagel
left a comment
fallenbagel
left a comment
There was a problem hiding this comment.
Two more small changes i would like.
- #3140 (comment) (this would make more sense and more consistent since every section in that page gets saved to settings.json)
- Could you make it single blank line after each section and not double? 😅
Removed the reference completely, I'm just doing this to get my other PR through.
Done |
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)
docs/using-seerr/settings/metadata.md (1)
14-15:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winClarify that Test only exercises selected providers.
Line 14 states Test "exercises every configured provider," but this contradicts lines 40–41 and the code behavior. Context snippet 1 (
SettingsMetadata.tsx:89–139) shows that TMDB is tested only if selected for TV or Anime, and TVDB is tested only if selected for TV or Anime. A provider that is available but not currently selected for any media type is not tested.📝 Proposed clarification
-A **Test** button at the top and bottom of the page exercises every configured -provider and updates the two status badges (`TheMovieDB`, `TheTVDB`). Each badge shows one of: +A **Test** button at the top and bottom of the page exercises each provider +that is currently selected for at least one media type and updates the two status badges (`TheMovieDB`, `TheTVDB`). Each badge shows one of:🤖 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/using-seerr/settings/metadata.md` around lines 14 - 15, Update the documentation sentence that currently says the Test button "exercises every configured provider" to clarify it only exercises providers that are selected for at least one media type (e.g., selected for TV or Anime); reference the settings UI behavior implemented in the SettingsMetadata component (see the test handler that conditionally tests TMDB and TVDB only when selected) and change the wording to something like "exercises each provider that is currently selected for one or more media types" so the prose matches the conditional testing logic.
🧹 Nitpick comments (1)
docs/using-seerr/settings/metadata.md (1)
38-38: ⚡ Quick winUse singular "button" for consistency.
Line 14 correctly refers to "A Test button at the top and bottom of the page" (one button appearing in two locations), but line 38 uses the plural "Test buttons."
📝 Proposed fix
-The **Test** buttons make one request per provider. +The **Test** button makes one request per provider.🤖 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/using-seerr/settings/metadata.md` at line 38, Replace the plural phrase in the sentence "The **Test** buttons make one request per provider." with the singular form to match the earlier wording; update that line to read "The **Test** button makes one request per provider." so it aligns with "A **Test** button at the top and bottom of the page."
🤖 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/using-seerr/settings/metadata.md`:
- Line 36: The section heading "Saving and Testing" does not match the content
(which only discusses testing); update the header text for the section
identified by the heading "Saving and Testing" in metadata.md to a title that
reflects the content such as "Testing" or "Testing behavior" so the heading and
body are consistent; ensure no other references to "Saving" remain in that
section.
---
Outside diff comments:
In `@docs/using-seerr/settings/metadata.md`:
- Around line 14-15: Update the documentation sentence that currently says the
Test button "exercises every configured provider" to clarify it only exercises
providers that are selected for at least one media type (e.g., selected for TV
or Anime); reference the settings UI behavior implemented in the
SettingsMetadata component (see the test handler that conditionally tests TMDB
and TVDB only when selected) and change the wording to something like "exercises
each provider that is currently selected for one or more media types" so the
prose matches the conditional testing logic.
---
Nitpick comments:
In `@docs/using-seerr/settings/metadata.md`:
- Line 38: Replace the plural phrase in the sentence "The **Test** buttons make
one request per provider." with the singular form to match the earlier wording;
update that line to read "The **Test** button makes one request per provider."
so it aligns with "A **Test** button at the top and bottom of the page."
🪄 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: 0f9bfe51-ece2-48b2-800f-c7982d35aa70
📒 Files selected for processing (1)
docs/using-seerr/settings/metadata.md
|
@M0NsTeRRR @fallenbagel do you want to review? |
| series. TheMovieDB is the default and matches the source used for movies, which | ||
| keeps IDs and artwork consistent across the UI. |
There was a problem hiding this comment.
Mention of movies in a section that talks about TV series is, imo, is quite weird. I feel this would sound more natural in the section above this.
There was a problem hiding this comment.
I think it would be more helpful if you used the edit button yourself for this though.
because this would mean rewriting 10%, then getting new review feedback on the rewrite ending in an endless loop of reviews.
There was a problem hiding this comment.
This message wasn't an affirmation but rather a thought that’s why he used phrases like 'imo' and 'I feel.' The goal was to gather feedback from you and the other maintainers.
Also, we avoid editing PRs directly because we let contributors manage their own PRs, as direct edits could be perceived as intrusive except if the author give this approval.
|
I'm removing the docs addition from the Music PR(s), instead. Feel free to edit this PR as your see fit. |
|
@Crow-Control I get that you want to move fast on Music, and we do too. But as a team of volunteers, things take the time they need. Reviews can take longer because everyone has their own voice and perspective that’s what makes Seerr better. Just so you know, your other PRs will likely go through the same process and require multiple reviews. We know it can be time-consuming, but that’s how the process works. That said, your message about dropping the PR came off a bit harsh. It’s not super motivating for us to start a review and then see the PR dropped it makes us hesitant to invest time in your future PRs if the same thing might happen again. |
6 participants
Description
Simple PR adding a page about metadata settings
Some AI has been used in initial generation, editing and proofreading done manually
How Has This Been Tested?
It has been read
Screenshots / Logs (if applicable)
Checklist:
pnpm buildpnpm i18n:extractSummary by CodeRabbit