Add smart shuffle documentation

[loucasal]

Closes #180.

I briefly considered going into the technicalities of the algorithm, but that seems entirely unnecessary for the average user.

[ByteHamster]

Thanks!

I briefly considered going into the technicalities of the algorithm, but that seems entirely unnecessary for the average user.

Then I maybe wouldn't mention Round-Robin. Round-Robin is technically the explanation of an algorithm that we do not use. Users who know what Round-Robin is would then assume that something is broken.

[loucasal]

Done - even simpler now.

[loucasal]

@keunes any comments or can this be merged as it is?

[keunes]

@loucasal @ByteHamster I'm wondering if it's worth adding a description of how it works in detail?

For example:

How it works in detail

Let's say you have 15 episodes in your queue; 1 from podcasts A, B and C each, 2 from podcast D and 10 from podcast E. It first It first spreads the podcast with most episodes (E) and places them spread out in the queue: EE_EE_E_E_EE_EE. The podcast with the second-most number of episodes (D) is then placed spread-out in the available slots: EE_EEDE_EDEE_EE. This continues, until we end up with: EE B EE D E C E D EE A EE.
The publishing date of each episode plays a role a) within podcasts (the episodes of podcast E are sorted accordingly) and b) between podcasts (in our example, the episode of podcast B gets an earlier spot than the episode of podcast A, because the former is more recent). Within date sorting, recently published gets higher in the queue.

If not, I think I would add a link to AntennaPod/AntennaPod/pull/6030 for a detailed explanation.

[loucasal]

As I said above:

I briefly considered going into the technicalities of the algorithm, but that seems entirely unnecessary for the average user.

Plus it would be another long chunk of rather detailed text for translators to localise. So let's add a link to the PR instead.

[ByteHamster]

I think I would slightly prefer stating the explanation on the website. The reason is that the PR explains the old variant first, which might confuse users. Also, leading them away from the documentation page might be a bit unexpected. Maybe we could add it with a new heading and have it excluded from the translations?