From ed20a1bd9076dd2c1c36b0fb1ec177af450b4fee Mon Sep 17 00:00:00 2001 From: Xoconoch Date: Sat, 23 Aug 2025 08:59:20 -0600 Subject: [PATCH] Revert "chore(docs): fix formatting" This reverts commit dada94134656228df6d74f4c8342eeb13d2ed836. --- docs/user/albums.md | 8 ++++---- docs/user/artists.md | 25 +++++++++++++------------ docs/user/configuration.md | 20 ++++++++++---------- docs/user/history.md | 10 +++++----- docs/user/multi-user.md | 6 +++--- docs/user/playlists.md | 24 ++++++++++++------------ docs/user/tracks.md | 8 ++++---- 7 files changed, 51 insertions(+), 50 deletions(-) diff --git a/docs/user/albums.md b/docs/user/albums.md index d5ad0df..838d7bf 100644 --- a/docs/user/albums.md +++ b/docs/user/albums.md @@ -11,7 +11,7 @@ Open an album from search or artist page. - Large albums - Tracks load progressively as you scroll -- Backend endpoints used: - - GET `/api/album/info?id=...&limit=50&offset=...` (metadata + paged tracks) - - GET `/api/album/download/{album_id}` (queue download) - - GET `/api/progress/stream` (live queue updates) \ No newline at end of file +Backend endpoints used: +- GET `/api/album/info?id=...&limit=50&offset=...` (metadata + paged tracks) +- GET `/api/album/download/{album_id}` (queue download) +- GET `/api/progress/stream` (live queue updates) \ No newline at end of file diff --git a/docs/user/artists.md b/docs/user/artists.md index dac8e26..36e3004 100644 --- a/docs/user/artists.md +++ b/docs/user/artists.md @@ -10,17 +10,18 @@ - Download any album individually - Watch - Add/remove artist to Watchlist (auto-download new releases when enabled) -- How-to: monitor an artist - 1. Search for the artist and open their page - 2. Click Watch - 3. Configure release types and intervals in Configuration → Watch -- How-to: download discography - 1. Open the artist page - 2. Choose release types (e.g., Albums, Singles, Compilations) - 3. Click Download All; track progress in Queue and History +How-to: monitor an artist +1. Search for the artist and open their page +2. Click Watch +3. Configure release types and intervals in Configuration → Watch -- Backend endpoints used: - - GET `/api/artist/info?id=...&limit=20&offset=...` (metadata + paged albums) - - GET `/api/artist/download/{artist_id}?album_type=album,single,compilation` (queue discography) - - PUT `/api/artist/watch/{artist_id}` / DELETE `/api/artist/watch/{artist_id}` / GET `/api/artist/watch/{artist_id}/status` \ No newline at end of file +How-to: download discography +1. Open the artist page +2. Choose release types (e.g., Albums, Singles, Compilations) +3. Click Download All; track progress in Queue and History + +Backend endpoints used: +- GET `/api/artist/info?id=...&limit=20&offset=...` (metadata + paged albums) +- GET `/api/artist/download/{artist_id}?album_type=album,single,compilation` (queue discography) +- PUT `/api/artist/watch/{artist_id}` / DELETE `/api/artist/watch/{artist_id}` / GET `/api/artist/watch/{artist_id}/status` \ No newline at end of file diff --git a/docs/user/configuration.md b/docs/user/configuration.md index fd56c62..7b5b9ba 100644 --- a/docs/user/configuration.md +++ b/docs/user/configuration.md @@ -30,15 +30,15 @@ Open Configuration in the web UI. Tabs: - Profile (all users when auth is enabled) - Change password, view role and email -- Quality formats (reference): - - Spotify: OGG 96k/160k/320k (320k requires Premium) - - Deezer: MP3 128k/320k (320k may require Premium), FLAC (Premium) - - Conversion: MP3/FLAC/AAC/OGG/OPUS/WAV/ALAC with custom bitrate +Quality formats (reference): +- Spotify: OGG 96k/160k/320k (320k requires Premium) +- Deezer: MP3 128k/320k (320k may require Premium), FLAC (Premium) +- Conversion: MP3/FLAC/AAC/OGG/OPUS/WAV/ALAC with custom bitrate -- Fallback system: - - Configure primary and fallback services - - Automatically switches if primary fails (useful for geo/account limits) +Fallback system: +- Configure primary and fallback services +- Automatically switches if primary fails (useful for geo/account limits) -- Notes: - - Explicit content filter applies in pages (e.g., hides explicit tracks on album/playlist views) - - Watch system must be enabled before adding items \ No newline at end of file +Notes: +- Explicit content filter applies in pages (e.g., hides explicit tracks on album/playlist views) +- Watch system must be enabled before adding items \ No newline at end of file diff --git a/docs/user/history.md b/docs/user/history.md index dc8cdb4..d1f0969 100644 --- a/docs/user/history.md +++ b/docs/user/history.md @@ -9,8 +9,8 @@ See all downloads and their outcomes. - Open an entry to view child tracks for albums/playlists - Re-queue failures from the UI -- Backend endpoints used: - - GET `/api/history?download_type=&status=&limit=&offset=` - - GET `/api/history/{task_id}` (entry) - - GET `/api/history/{task_id}/children` (child tracks) - - GET `/api/history/stats`, `/api/history/recent`, `/api/history/failed` (summaries) \ No newline at end of file +Backend endpoints used: +- GET `/api/history?download_type=&status=&limit=&offset=` +- GET `/api/history/{task_id}` (entry) +- GET `/api/history/{task_id}/children` (child tracks) +- GET `/api/history/stats`, `/api/history/recent`, `/api/history/failed` (summaries) \ No newline at end of file diff --git a/docs/user/multi-user.md b/docs/user/multi-user.md index b4f1d82..0030da8 100644 --- a/docs/user/multi-user.md +++ b/docs/user/multi-user.md @@ -15,6 +15,6 @@ Authentication is optional. When enabled: - Create/delete users, change roles - Reset user passwords -- Where to find it in the UI: - - User menu (top-right) → Profile settings - - Configuration → User Management (admin) \ No newline at end of file +Where to find it in the UI: +- User menu (top-right) → Profile settings +- Configuration → User Management (admin) \ No newline at end of file diff --git a/docs/user/playlists.md b/docs/user/playlists.md index 3fe91bb..adeab3b 100644 --- a/docs/user/playlists.md +++ b/docs/user/playlists.md @@ -11,16 +11,16 @@ Open a playlist from search. - Watch - Add/remove playlist to Watchlist (auto-download new additions when enabled) -- How-to: download a playlist - 1. Search for the playlist or paste its Spotify URL - 2. Click Download - 3. Monitor progress in the Queue; results appear in History +How-to: download a playlist +1. Search for the playlist or paste its Spotify URL +2. Click Download +3. Monitor progress in the Queue; results appear in History -- Backend endpoints used: - - GET `/api/playlist/metadata?id=...` (metadata only) - - GET `/api/playlist/tracks?id=...&limit=50&offset=...` (paged tracks) - - GET `/api/playlist/info?id=...&include_tracks=true` (full info when needed) - - GET `/api/playlist/download/{playlist_id}` (queue download) - - PUT `/api/playlist/watch/{playlist_id}` (watch) - - DELETE `/api/playlist/watch/{playlist_id}` (unwatch) - - GET `/api/playlist/watch/{playlist_id}/status` (status) \ No newline at end of file +Backend endpoints used: +- GET `/api/playlist/metadata?id=...` (metadata only) +- GET `/api/playlist/tracks?id=...&limit=50&offset=...` (paged tracks) +- GET `/api/playlist/info?id=...&include_tracks=true` (full info when needed) +- GET `/api/playlist/download/{playlist_id}` (queue download) +- PUT `/api/playlist/watch/{playlist_id}` (watch) +- DELETE `/api/playlist/watch/{playlist_id}` (unwatch) +- GET `/api/playlist/watch/{playlist_id}/status` (status) \ No newline at end of file diff --git a/docs/user/tracks.md b/docs/user/tracks.md index e6a45d9..e51cf33 100644 --- a/docs/user/tracks.md +++ b/docs/user/tracks.md @@ -10,7 +10,7 @@ Find a track via search or open a track page. - Details shown - Artists, album, duration, popularity -- Backend endpoints used: - - GET `/api/track/info?id=...` (metadata) - - GET `/api/track/download/{track_id}` (queue download) - - GET `/api/progress/stream` (live queue updates) \ No newline at end of file +Backend endpoints used: +- GET `/api/track/info?id=...` (metadata) +- GET `/api/track/download/{track_id}` (queue download) +- GET `/api/progress/stream` (live queue updates) \ No newline at end of file