Improve Readme - #248
Conversation
Updated the README to clarify limitations of current sections and installation steps.
Apparently there was already a reference to a hard(force) refresh, I updated that to use the same term as used in the FAQ, and link to the FAQ section so that people hopefully find the instructions on hos to do the hard reload
There was a problem hiding this comment.
Pull request overview
Updates the README documentation for the Home Screen Sections Jellyfin plugin to better reflect required dependencies, simplify cache-clearing guidance, and document additional limitations of the “Recently Added Media” section.
Changes:
- Adds an explicit prerequisite reminder to the installation steps.
- Simplifies the FAQ guidance for resolving stale UI/options by clearing cache via hard refresh.
- Expands documented limitations for the “Recently Added Media” section.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - Mostly the same as vanilla Jellyfin, current exceptions: | ||
| - all libraries appear in 1 section rather than unique ones per library. This vanilla behaviour is being worked on and will soon be supported. | ||
| - it does not currently pick up individual newly episodes |
| 5. At the top there is a button to enable support and it will retrieve all sections that are available on your instance. Select all that apply. | ||
| 6. Save the settings. _Please note currently the user is not provided any feedback when the settings are saved_. | ||
| 7. Force refresh your webpage (or app) and you should see your new sections instead of the original ones. | ||
| 2. Ensure the [prerequisites](#prerequisites) are installed - they are also in the above repository |
| That can be achived in different ways. | ||
|
|
||
| The easiest way is a hard refresh, this can be done - **on the Jellyfin home page** - via `Ctrl(Cmd) + Shift + R` on most browsers, you can look it up for your browser and and OS. |
|  | ||
| That can be achived in different ways. | ||
|
|
||
| The easiest way is a hard refresh, this can be done - **on the Jellyfin home page** - via `Ctrl(Cmd) + Shift + R` on most browsers, you can look it up for your browser and and OS. |
There was a problem hiding this comment.
A hard refresh does not 100% of the time work which is why it wasn't mentioned. I'd rather not have a million issues created because hard refresh didn't work but the disable cache method does.
There was a problem hiding this comment.
What situations does a hard refresh not work for, where your suggested approach does work? Because the only situations where a hard refresh, from my model, would have issues is when getting stale results on page navigation (and/or not doing the hard refresh on the correct page, which is why I stated to do it on the jellyfin home page). And that doesnt really get properly addressed by your instructions too.
Honestly, the only surefire way to avoid any caching issues IMO is to either delete all site data - which will also destroys other things like your login - or to open a fresh private window to that page to check things and then try to make it work with less destructive means in your main instance after.
There was a problem hiding this comment.
I have had issues where after first install the disk cache was still being used for the injected files resulting in the plugins not working. The only way I could consistently get the page to load in from the server was via the disable cache approach
There was a problem hiding this comment.
Disable cache in the way I've got documented basically tells the browser to skip the disk cache and request from the server
| - Mostly the same as vanilla Jellyfin, current exception is that all libraries appear in 1 section rather than unique ones per library. This vanilla behaviour is being worked on and will soon be supported. | ||
| - Mostly the same as vanilla Jellyfin, current exceptions: | ||
| - all libraries appear in 1 section rather than unique ones per library. This vanilla behaviour is being worked on and will soon be supported. | ||
| - it does not currently pick up individual newly episodes |
There was a problem hiding this comment.
This is an inaccurate statement and further misleading
Just because the section shows the show not the episode does not mean it's not working on episodes (which it is)
If you have an existing show, and a new episode is added, the show will appear in the section.
I've made a note to allow the user to choose whether to show episodes or shows in this section for my next release so this might not be worth adding as it should be possible to choose on or the other in the next release
There was a problem hiding this comment.
Yeah I wasn't entirely sure what was accurate here, tbh, because of the other issue mentioned in the PR text. The only library I add new episodes to is a mixed one, that doesn't currently show in the section. I tried to fix it up to be somewhat generic, but when re-reading it right now I already see at least a grammatical error...
There was a problem hiding this comment.
I think the best way would be perhaps to state that there are some limitations, and then link to the issues /PRs about the limitations instead. That would also cover the point in the PR text we discussed, and avoids being stale (well, the issues may be closed already).
Yeah that's covered by #241 which I'm actively investigating a solve for. These aren't library types I use and was actually unaware of when implementing so they've gone under the radar and now I need to figure out a way to get them integrated |
Modifying the Readme to account for
I also think that there are yet more limitations with current recreation of the recently added media section. It completely fails to pick up changes in one of my libraries. I believe that that is probably because that library contains mixed shows and movies. If that makes sense to you, it should probably be added as another limitation