docs: rearrange paths, update links and redirects

Part-of: <https://dev.funkwhale.audio/funkwhale/funkwhale/-/merge_requests/2353>
This commit is contained in:
Ciarán Ainsworth 2023-02-01 13:41:44 +01:00
commit 65316d43c1
169 changed files with 254 additions and 255 deletions

32
docs/user/queue/album.md Normal file
View file

@ -0,0 +1,32 @@
# Add albums to your queue
Add entire albums to your queue to start listening to them. Choose from the following **Play options**:
- **Play** remove all content from the queue and play the selected album.
- **Add to queue** add the selected album to the end of the queue.
- **Play next** add the selected album to the next position in the queue.
- **Play now** play the selected album immediately but do not clear the queue.
You can add albums from the following places:
```{contents}
:local:
```
## From the album details page
To add an album to the queue from the album details page:
1. Go to the album's details page.
2. Select the orange play button ({fa}`play`) to **Play** the album. Select the dropdown icon ({fa}`caret-down`) to select a different **Play option**.
You're done! You've added the album to your queue.
## From an album card
To add an album from its album card:
1. Find the album card in the interface.
2. Select the orange play button ({fa}`play`) to **Play** the album. Select the kebab menu ({fa}`ellipsis-v`) to select a different **Play option**.
That's it! You've added the album to your queue.

32
docs/user/queue/artist.md Normal file
View file

@ -0,0 +1,32 @@
# Add artist discographies to your queue
Add an artist's entire discography to your queue to start listening to it. Choose from the following **Play options**:
- **Play** remove all content from the queue and play the artist's discography.
- **Add to queue** add the selected artist's discography to the end of the queue.
- **Play next** add the selected artist's discography to the next position in the queue.
- **Play now** play the artist's discography immediately but do not clear the queue.
You can add an artist's discography from the following places:
```{contents}
:local:
```
## From the artist details page
To add an artist's discography to the queue from the artist details page:
1. Go to the artist's details page.
2. Select the orange play button ({fa}`play`) to **Play** the album. Select the {guilabel}`More…` to select a different **Play option**.
You're done! You've added the artist's discography to your queue.
## From an artist card
To add an artist's discography from their artist card:
1. Find the artist card in the interface.
2. Select the orange play button ({fa}`play`) to **Play** the album. Select the kebab menu ({fa}`ellipsis-v`) to select a different **Play option**.
That's it! You've added the artist's discography to your queue.

21
docs/user/queue/index.md Normal file
View file

@ -0,0 +1,21 @@
# Queue
Use the audio queue to manage audio playback. You can add tracks, albums, series, artist discographies, and playlists to your queue.
Follow the guides in this section to get started.
```{toctree}
---
caption: Manage your queue
maxdepth: 1
---
tracks
album
series
artist
playlist
rearrange
remove
```

View file

@ -0,0 +1,32 @@
# Add playlists to your queue
Add entire playlists to your queue to start listening to them. Choose from the following **Play options**:
- **Play** remove all content from the queue and play the selected playlist.
- **Add to queue** add the selected playlist to the end of the queue.
- **Play next** add the selected playlist to the next position in the queue.
- **Play now** play the selected playlist immediately but do not clear the queue.
You can add playlists from the following places:
```{contents}
:local:
```
## From the playlist details page
To add an playlist to the queue from the playlist details page:
1. Go to the playlist's details page.
2. Select {guilabel}`Play all` to **Play** the playlist. Select the dropdown icon ({fa}`caret-down`) to select a different **Play option**.
You're done! You've added the playlist to your queue.
## From an playlist card
To add an playlist from its playlist card:
1. Find the playlist card in the interface.
2. Select the orange play button ({fa}`play`) to **Play** the playlist. Select the kebab menu ({fa}`ellipsis-v`) to select a different **Play option**.
That's it! You've added the playlist to your queue.

View file

@ -0,0 +1,14 @@
# Rearrange content in your queue
```{note}
Rearranging content is currently only supported on the desktop.
```
You can change the order of content in your queue at any time. To do this:
1. Select the up arrow ({fa}`caret-up`) on the queue menu to expand the queue.
2. Pick up tracks by selecting the grip lines on the left. Your mouse pointer shows a hand ({fa}`hand-grab-o`).
3. Drop the tracks in their new position in the queue.
4. Select {guilabel}`Close` to close the queue.
That's it! You've rearranged the content in your queue.

63
docs/user/queue/remove.md Normal file
View file

@ -0,0 +1,63 @@
# Remove content from your queue
```{note}
If you remove the currently playing track, the next item in the queue plays. If you remove all items, the queue closes.
```
You can remove content from your queue at any time. You can choose between the following options:
```{contents}
:local:
```
## Remove individual tracks from the queue
To remove individual tracks from the queue:
::::{tab-set}
:::{tab-item} Desktop
:sync: desktop
1. Select the up arrow ({fa}`caret-up`) on the queue menu to expand the queue.
2. Select the delete icon ({fa}`times`) next to the track you want to remove.
:::
:::{tab-item} Mobile
:sync: 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.
3. Select the delete icon ({fa}`times`) next to the track you want to remove.
:::
::::
That's it! You've removed tracks from your queue.
## Remove all content from the queue
To remove all content from your queue at once:
::::{tab-set}
:::{tab-item} Desktop
:sync: desktop
1. Select the up arrow ({fa}`caret-up`) on the queue menu to expand the queue.
2. Select {guilabel}`Clear` to remove all content from the queue.
:::
:::{tab-item} Mobile
:sync: 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.
3. Select {guilabel}`Clear` to remove all content from the queue.
:::
::::
That's it! You've removed all content from your queue.

15
docs/user/queue/series.md Normal file
View file

@ -0,0 +1,15 @@
# Add series to your queue
Add entire series to your queue to start listening to them. Choose from the following **Play options**:
- **Play** remove all content from the queue and play the selected series.
- **Add to queue** add the selected series to the end of the queue.
- **Play next** add the selected series to the next position in the queue.
- **Play now** play the selected series immediately but do not clear the queue.
To add a series to the queue from the album details page:
1. Go to the series' details page.
2. Select the orange play button ({fa}`play`) to **Play** the series. Select the dropdown icon ({fa}`caret-down`) to select a different **Play option**.
You're done! You've added the series to your queue.

15
docs/user/queue/tracks.md Normal file
View file

@ -0,0 +1,15 @@
# Add tracks to your queue
Add tracks to your queue to start listening to them. Choose from the following **Play options**:
- **Play** remove all content from the queue and play the selected track.
- **Add to queue** add the selected track to the end of the queue.
- **Play next** add the selected track to the next position in the queue.
- **Play now** play the selected track immediately but do not clear the queue.
To add a track to the queue:
1. Find your track in a track table.
2. Select the orange play button ({fa}`play`) to **Play** the track. Select the kebab menu ({fa}`ellipsis-v`) to select a different **Play option**.
That's it! You've added the track to your queue.