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,76 @@
# Add content to a playlist
To build a playlist, you need to add content to it. You can add content in a few different ways:
```{contents}
:local:
```
## Add the currently playing track
If you want to add the currently playing track to a playlist:
```{tabbed} Desktop
1. Select the playlist icon ({fa}`list`) on the player. The {guilabel}`Manage playlists` screen appears.
2. Select {guilabel}`+ Add track` next to the playlist you want to add the track to.
```
```{tabbed} Mobile
1. Select the player at the bottom of the screen to expand it.
2. Select the playlist icon ({fa}`list`) under the track art. The {guilabel}`Manage playlists` screen appears.
3. Select {guilabel}`+ Add track` next to the playlist you want to add the track to.
```
That's it! The currently playing track is now in your playlist.
## Add content from queue
You can add all content that is currently in your [player queue](../queue/index.md). To do this:
```{tabbed} Desktop
1. Select {guilabel}`Playlists` under the {guilabel}`My Library` section of the sidebar. The {guilabel}`Browsing playlists` screen opens.
2. Select {guilabel}`Manage your playlists`. The {guilabel}`Manage playlists` screen appears.
3. Select the edit icon ({fa}`edit`) next to the playlist you want to edit. The playlist edit screen appears.
4. Select {guilabel}`+ Insert from queue`. Your tracks appear in the playlist. The changes save to the server.
5. Select {guilabel}`Stop editing` to stop editing.
```
```{tabbed} Mobile
1. Select the hamburger menu ({fa}`bars`) to open the menu bar.
2. Select {menuselection}`My Library --> Playlists`. The {guilabel}`Browsing playlists` screen opens.
3. Select {guilabel}`Manage your playlists`. The {guilabel}`Manage playlists` screen appears.
4. Select the edit icon ({fa}`edit`) next to the playlist you want to edit. The playlist edit screen appears.
5. Select {guilabel}`+ Insert from queue`. Your tracks appear in the playlist. The changes save to the server.
6. Select {guilabel}`Stop editing` to stop editing.
```
That's it! You've added the contents from your queue to a playlist.
## Add track from track details page
You can add a track to a playlist from the track details page. To do this:
1. Go to the track details page of the track you want to add.
2. Select the playlist icon ({fa}`list`) at the top of the screen. The {guilabel}`Manage playlists` screen appears.
3. Select {guilabel}`+ Add track` next to the playlist you want to add the track to.
That's it! The track is available in your playlist.
## Add track from track table
You can add tracks from any page with a track table. This includes artist pages, album pages, and the search page. To add tracks from the track table:
1. Find your track in a track table.
2. Select the kebab menu ({fa}`ellipsis-v`) next to the track to open the track options menu.
3. Select {guilabel}`Add to playlist…`. The {guilabel}`Manage playlists` screen appears.
4. Select {guilabel}`+ Add track` next to the playlist you want to add the track to.
Well done! You've added the track to your playlist.

View file

@ -0,0 +1,36 @@
# Create a playlist
Create playlists to share your favorite tracks with other Funkwhale users.
To create a playlist:
```{tabbed} Desktop
1. Log in to your account.
2. Select {guilabel}`Playlists` under the {guilabel}`My Library` section of the sidebar. The {guilabel}`Browsing playlists` screen opens.
3. Select {guilabel}`Manage your playlists`. The {guilabel}`Manage playlists` screen appears.
4. Enter a {guilabel}`Playlist name` for your new playlist.
5. Select the {guilabel}`Playlist visibility` for your playlist. Choose from the following options:
- {guilabel}`Everyone, across all instances` the playlist is available to everybody who interacts with your {term}`pod`. This includes users of other pods.
- {guilabel}`Everyone on this instance` the playlist is available to all users on your pod. This does not include users of other pods.
- {guilabel}`Nobody except me` the playlist is only available to you and people you share it with.
6. Select {guilabel}`Create playlist`. A {guilabel}`Playlist created` message appears.
```
```{tabbed} Mobile
1. Log in to your account.
2. Select the hamburger menu ({fa}`bars`) to open the menu bar.
3. Select {menuselection}`My Library --> Playlists`. The {guilabel}`Browsing playlists` screen opens.
4. Select {guilabel}`Manage your playlists`. The {guilabel}`Manage playlists` screen appears.
5. Enter a {guilabel}`Playlist name` for your new playlist.
6. Select the {guilabel}`Playlist visibility` for your playlist. Choose from the following options:
- {guilabel}`Everyone, across all instances` the playlist is available to everybody who interacts with your pod. This includes users of other pods.
- {guilabel}`Everyone on this instance` the playlist is available to all users on your pod. This does not include users of other pods.
- {guilabel}`Nobody except me` the playlist is only available to you and people you share it with.
7. Select {guilabel}`Create playlist`. A {guilabel}`Playlist created` message appears.
```
Congratulations! You've created your playlist. Now you can [add some content to it](add_content.md).

View file

@ -0,0 +1,32 @@
# Delete a playlist
```{warning}
Deleting a playlist removes the playlist for all users. This action is irreversible.
```
You can delete a playlist if you no longer want it. To do this:
```{tabbed} Desktop
1. Log in to your account.
2. Select {guilabel}`Playlists` under the {guilabel}`My Library` section of the sidebar. The {guilabel}`Browsing playlists` screen opens.
3. Select {guilabel}`Manage your playlists`. The {guilabel}`Manage playlists` screen appears.
4. Select the playlist from the {guilabel}`Available playlists` list. The playlist details screen opens.
5. Select {guilabel}`Delete`. A {guilabel}`Do you want to delete the playlist?` warning appears.
6. Select {guilabel}`Delete playlist`.
```
```{tabbed} Mobile
1. Log in to your account.
2. Select the hamburger menu ({fa}`bars`) to open the menu bar.
3. Select {menuselection}`My Library --> Playlists`. The {guilabel}`Browsing playlists` screen opens.
4. Select {guilabel}`Manage your playlists`. The {guilabel}`Manage playlists` screen appears.
5. Select the playlist from the {guilabel}`Available playlists` list. The playlist details screen opens.
6. Select {guilabel}`Delete`. A {guilabel}`Do you want to delete the playlist?` warning appears.
7. Select {guilabel}`Delete playlist`.
```
That's it! You've deleted your playlist.

View file

@ -0,0 +1,32 @@
# Edit a playlist
You can edit the details of your playlists at any time. To do this:
```{tabbed} Desktop
1. Log in to your account.
2. Select {guilabel}`Playlists` under the {guilabel}`My Library` section of the sidebar. The {guilabel}`Browsing playlists` screen opens.
3. Select {guilabel}`Manage your playlists`. The {guilabel}`Manage playlists` screen appears.
4. Select the edit icon ({fa}`edit`) next to the playlist you want to edit. The playlist edit screen appears.
5. Update the following fields:
- {guilabel}`Playlist name`.
- {guilabel}`Playlist visibility`.
6. Select {guilabel}`Update playlist` to save your changes. A message displays {guilabel}`Playlist updated`.
```
```{tabbed} Mobile
1. Log in to your account.
2. Select the hamburger menu ({fa}`bars`) to open the menu bar.
3. Select {menuselection}`My Library --> Playlists`. The {guilabel}`Browsing playlists` screen opens.
4. Select {guilabel}`Manage your playlists`. The {guilabel}`Manage playlists` screen appears.
5. Select the edit icon ({fa}`edit`) next to the playlist you want to edit. The playlist edit screen appears.
6. Update the following fields:
- {guilabel}`Playlist name`.
- {guilabel}`Playlist visibility`.
7. Select {guilabel}`Update playlist` to save your changes. A message displays {guilabel}`Playlist updated`.
```
That's it! You've edited your playlist.

View file

@ -0,0 +1,28 @@
# Playlists
You can create and share playlists with the {term}`Fediverse`. Add content from all over the network to build playlists you love.
```{toctree}
---
caption: Manage your playlists
maxdepth: 1
---
create_playlist
edit_playlist
listen_playlist
delete_playlist
```
```{toctree}
---
caption: Manage playlist content
maxdepth: 1
---
add_content
reorder_content
remove_content
```

View file

@ -0,0 +1,57 @@
# Listen to a playlist
```{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 playlists or playlists created by other users of your {term}`pod`.
```{contents}
:local:
```
## Listen to your playlists
To listen to playlists you created:
```{tabbed} Desktop
1. Select {menuselection}`My Library --> Playlists` in the sidebar. The {guilabel}`Browsing playlists` screen opens.
2. Use the filters to search for your playlist.
3. Select the orange play icon ({fa}`play`) on your playlist to start playing the content.
```
```{tabbed} Mobile
1. Select the hamburger menu ({fa}`bars`) to open the menu bar.
2. Select {menuselection}`My Library --> Playlists`. The {guilabel}`Browsing playlists` screen opens.
3. Use the filters to search for your playlist.
4. Select the orange play icon ({fa}`play`) on your playlist to start playing the content.
```
You're done! Your playlist's content appears in your [queue](../queue/index.md).
## Listen to public playlists from your pod
To listen to public playlists other users created:
```{tabbed} Desktop
1. Select {menuselection}`Explore --> Playlists` in the sidebar. The {guilabel}`Browsing playlists` screen opens.
2. Use the filters to search for a playlist.
3. Select the orange play icon ({fa}`play`) on your selected playlist to start playing the content.
```
```{tabbed} Mobile
1. Select the hamburger menu ({fa}`bars`) to open the menu bar.
2. Select {menuselection}`Explore --> Playlists`. The {guilabel}`Browsing playlists` screen opens.
3. Use the filters to search for a playlist.
4. Select the orange play icon ({fa}`play`) on your selected playlist to start playing the content.
```
That's it! The playlist's content appears in your [queue](../queue/index.md).

View file

@ -0,0 +1,32 @@
# Remove content from a playlist
```{warning}
Removing content from a playlist removes it for anybody who follows the playlist.
```
You can remove content from a playlist at any time. To do this:
```{tabbed} Desktop
1. Log in to your account.
2. Select {guilabel}`Playlists` under the {guilabel}`My Library` section of the sidebar. The {guilabel}`Browsing playlists` screen opens.
3. Select {guilabel}`Manage your playlists`. The {guilabel}`Manage playlists` screen appears.
4. Select the edit icon ({fa}`edit`) next to the playlist you want to edit. The playlist edit screen appears.
5. Select the delete icon ({fa}`trash`) next to the content you want to remove. Select {guilabel}`Clear playlist` to remove all content at once.
6. Select {guilabel}`Stop Editing` to finish editing.
```
```{tabbed} Mobile
1. Log in to your account.
2. Select the hamburger menu ({fa}`bars`) to open the menu bar.
3. Select {menuselection}`My Library --> Playlists`. The {guilabel}`Browsing playlists` screen opens.
4. Select {guilabel}`Manage your playlists`. The {guilabel}`Manage playlists` screen appears.
5. Select the edit icon ({fa}`edit`) next to the playlist you want to edit. The playlist edit screen appears.
6. Select the delete icon ({fa}`trash`) next to the content you want to remove. Select {guilabel}`Clear playlist` to remove all content at once.
7. Select {guilabel}`Stop Editing` to finish editing.
```
That's it! You've removed the content from your playlist.

View file

@ -0,0 +1,29 @@
# Reorder content in a playlist
You can change the order of the tracks in a playlist. To do this:
```{tabbed} Desktop
1. Log in to your account.
2. Select {guilabel}`Playlists` under the {guilabel}`My Library` section of the sidebar. The {guilabel}`Browsing playlists` screen opens.
3. Select {guilabel}`Manage your playlists`. The {guilabel}`Manage playlists` screen appears.
4. Select the edit icon ({fa}`edit`) next to the playlist you want to edit. The playlist edit screen appears.
5. Drag and drop the tracks in the playlist into the order you want. The position number of each track appears on the left side.
6. Select {guilabel}`Stop Editing` to finish editing.
```
```{tabbed} Mobile
1. Log in to your account.
2. Select the hamburger menu ({fa}`bars`) to open the menu bar.
3. Select {menuselection}`My Library --> Playlists`. The {guilabel}`Browsing playlists` screen opens.
4. Select {guilabel}`Manage your playlists`. The {guilabel}`Manage playlists` screen appears.
5. Select the edit icon ({fa}`edit`) next to the playlist you want to edit. The playlist edit screen appears.
6. Drag and drop the tracks in the playlist into the order you want. The position number of each track appears on the left side.
7. Select {guilabel}`Stop Editing` to finish editing.
```
You're done! You've updated the order of the tracks in your playlist.