Overhaul end user documentation

This commit is contained in:
Ciarán Ainsworth 2022-01-19 18:49:46 +00:00
commit 1ec7e1e8e5
97 changed files with 3240 additions and 1553 deletions

View file

@ -0,0 +1,48 @@
# Create a radio
```{note}
If you add content from a __private__ library to a __public__ radio, users can see the tracks but can't play them.
```
Create a new radio to create a dynamic playlist of content based on filters. You can filter tracks by __Artist__ and __Tag__.
To create a new radio:
```{tabbed} Desktop
1. Select {guilabel}`Radios` in the sidebar. The {guilabel}`Browsing radios` screen opens.
2. Select {guilabel}` Create your own radio` under the {guilabel}`User radios` section. The {guilabel}`Builder` screen opens.
3. Enter a {guilabel}`Radio name`.
4. __Optional__ enter a {guilabel}`Description` for your radio.
5. To make your radio available to other users on your {term}`pod`, enable the {guilabel}`Display publicly` switch. If you disable this switch, only you can see the radio.
6. Select {guilabel}`Artist` or {guilabel}`Tag` from the {guilabel}`Select a filter` dropdown.
7. Select {guilabel}`Add filter` to add the filter to your radio.
8. Configure your filter:
1. Enable the {guilabel}`Exclude` switch to exclude results from your selection in the radio. Disable this switch to include results from your selection in the radio.
2. Choose your __Artists__ or __Tags__ in the {guilabel}`Config` dropdown menu.
3. The {guilabel}`Candidates` column shows the number of tracks included. Select the {guilabel}`{count} tracks matching filter` option to view some of these tracks.
9. Check the tracks under the {guilabel}`{count} tracks matching combined filters` section.
10. Select {guilabel}`Save` to save your radio.
```
```{tabbed} Mobile
1. Select the hamburger menu ({fa}`bars`) to open the menu bar.
2. Select {menuselection}`Explore --> Radios` or {menuselection}`My Library --> Radios`. The {guilabel}`Browsing radios` screen opens.
3. Select {guilabel}` Create your own radio` under the {guilabel}`User radios` section. The {guilabel}`Builder` screen opens.
4. Enter a {guilabel}`Radio name`.
5. __Optional__ enter a {guilabel}`Description` for your radio.
6. To make your radio available to other users on your {term}`pod`, enable the {guilabel}`Display publicly` switch. If you disable this switch, only you can see the radio.
7. Select {guilabel}`Artist` or {guilabel}`Tag` from the {guilabel}`Select a filter` dropdown.
8. Select {guilabel}`Add filter` to add the filter to your radio.
9. Configure your filter:
1. Enable the {guilabel}`Exclude` switch to exclude results from your selection in the radio. Disable this switch to include results from your selection in the radio.
2. Choose your __Artists__ or __Tags__ in the {guilabel}`Config` dropdown menu.
3. The {guilabel}`Candidates` column shows the number of tracks included. Select the {guilabel}`{count} tracks matching filter` option to view some of these tracks.
10. Check the tracks under the {guilabel}`{count} tracks matching combined filters` section.
11. Select {guilabel}`Save` to save your radio.
```
You're done! You can now play your radio.

View file

@ -0,0 +1,27 @@
# Delete a radio
```{warning}
Users who have access to your radio won't be able to access it when you delete it. This action is irreversible.
```
If you no longer want a radio, you can delete it. To do this:
```{tabbed} Desktop
1. Select {guilabel}`Radios` in the sidebar. The {guilabel}`Browsing radios` screen opens.
2. Select your radio under the {guilabel}`User radios` section. The radio details screen opens.
3. Select {guilabel}`Delete`. A {guilabel}`Do you want to delete the radio` warning appears.
4. Select {guilabel}`Delete radio`.
```
```{tabbed} Mobile
1. Select the hamburger menu ({fa}`bars`) to open the menu bar.
2. Select {menuselection}`Explore --> Radios` or {menuselection}`My Library --> Radios`. The {guilabel}`Browsing radios` screen opens.2. 3. Select your radio under the {guilabel}`User radios` section. The radio details screen opens.
4. Select {guilabel}`Delete`. A {guilabel}`Do you want to delete the radio` warning appears.
5. Select {guilabel}`Delete radio`.
```
That's it! You've deleted your radio. You can [create a new one](create_radio.md) at any time.

View file

@ -0,0 +1,32 @@
# Edit a radio
You can edit a radio at any time to change its details, its filters, or both. To do this:
```{tabbed} Desktop
1. Select {guilabel}`Radios` in the sidebar. The {guilabel}`Browsing radios` screen opens.
2. Find your radio under the {guilabel}`User radios` section. Select {guilabel}`Edit`. The {guilabel}`Builder` screen opens.
3. Edit any of the following:
- {guilabel}`Radio name`.
- {guilabel}`Description`.
- {guilabel}`Display publicly`.
4. Select {guilabel}`Add filter` to add new filters. Select {guilabel}`Remove` to remove existing filters.
5. Select {guilabel}`Save` to save your radio.
```
```{tabbed} Mobile
1. Select the hamburger menu ({fa}`bars`) to open the menu bar.
2. Select {menuselection}`Explore --> Radios` or {menuselection}`My Library --> Radios`. The {guilabel}`Browsing radios` screen opens.
3. Find your radio under the {guilabel}`User radios` section. Select {guilabel}`Edit`. The {guilabel}`Builder` screen opens.
4. Edit any of the following:
- {guilabel}`Radio name`.
- {guilabel}`Description`.
- {guilabel}`Display publicly`.
5. Select {guilabel}`Add filter` to add new filters. Select {guilabel}`Remove` to remove existing filters.
6. Select {guilabel}`Save` to save your radio.
```
That's it! You've updated your radio's details.

View file

@ -0,0 +1,24 @@
# Radios
Radios are a great way to discover new music or rediscover old favorites. A radio builds a dynamic playlist of content based on selected criteria. Create genre and artist radios, or tune in to one of Funkwhale's built-in radios.
Funkwhale offers the following radios out of the box:
- __Your content__ listen to content from [libraries](../libraries/index.md) you own.
- __Favorites__ listen to tracks from your [favorites](../favorites/index.md) list.
- __Random__ discover something new by letting Funkwhale choose tracks at random.
- __Recently Added__ listen to the latest content added to your {term}`pod`.
- __Less listened__ check out tracks you've not heard, or things you haven't given as much attention.
```{toctree}
---
caption: Manage your radios
maxdepth: 1
---
create_radio
edit_radio
listen_radio
delete_radio
```

View file

@ -0,0 +1,78 @@
# Listen to a radio
```{note}
You can only listen to content in libraries you have access to. For more information, see [Follow a library](../libraries/follow_library).
```
You can listen to your radios or public radios created by other users of your {term}`pod`.
```{contents}
:local:
```
## Listen to your radios
To listen to radios you created:
```{tabbed} Desktop
1. Select {menuselection}`My Library --> Radios` in the sidebar. The {guilabel}`Browsing radios` screen opens.
2. Use the filters in the {guilabel}`User radios` section to search for your radio.
3. Select {guilabel}`Play radio` on your radio to start playing the content.
```
```{tabbed} Mobile
1. Select the hamburger menu ({fa}`bars`) to open the menu bar.
2. Select {menuselection}`My Library --> Radios`. The {guilabel}`Browsing radios` screen opens.
3. Use the filters in the {guilabel}`User radios` section to search for your radio.
4. Select {guilabel}`Play radio` on your radio to start playing the content.
```
You're done! Your radio starts playing.
## Listen to public radios from your pod
To listen to public radios other users created:
```{tabbed} Desktop
1. Select {menuselection}`Explore --> Radios` in the sidebar. The {guilabel}`Browsing radios` screen opens.
2. Use the filters in the {guilabel}`User radios` section to search for a radio.
3. Select {guilabel}`Play radio` on the selected radio to start playing the content.
```
```{tabbed} Mobile
1. Select the hamburger menu ({fa}`bars`) to open the menu bar.
2. Select {menuselection}`Explore --> Radios`. The {guilabel}`Browsing radios` screen opens.
3. Use the filters in the {guilabel}`User radios` section to search for a radio.
4. Select {guilabel}`Play radio` on the selected radio to start playing the content.
```
That's it! The radio starts playing.
## Stop a radio
Radios continue to play until there is no more content matching their criteria. You can stop radios whenever you want. To do this:
```{tabbed} Desktop
1. Select the up arrow ({fa}`caret-up`) on the queue menu to expand the [queue](../queue/index.md).
2. Select {guilabel}`Stop Radio` at the bottom of the queue.
```
```{tabbed} Mobile
1. Select the player bar at the bottom of the screen to expand the player.
2. Select the up arrow ({fa}`caret-up`) on the queue menu to expand the [queue](../queue/index.md).
3. Select {guilabel}`Stop Radio` at the bottom of the queue.
```
That's it! The radio stops playing. The radio's content remains in the queue.