chore(docs): fix formatting

This commit is contained in:
Xoconoch
2025-08-23 09:00:39 -06:00
parent ed20a1bd90
commit 97b26876bd
8 changed files with 12 additions and 0 deletions

View File

@@ -12,6 +12,7 @@ Open an album from search or artist page.
- Tracks load progressively as you scroll - Tracks load progressively as you scroll
Backend endpoints used: Backend endpoints used:
- GET `/api/album/info?id=...&limit=50&offset=...` (metadata + paged tracks) - GET `/api/album/info?id=...&limit=50&offset=...` (metadata + paged tracks)
- GET `/api/album/download/{album_id}` (queue download) - GET `/api/album/download/{album_id}` (queue download)
- GET `/api/progress/stream` (live queue updates) - GET `/api/progress/stream` (live queue updates)

View File

@@ -12,16 +12,19 @@
- Add/remove artist to Watchlist (auto-download new releases when enabled) - Add/remove artist to Watchlist (auto-download new releases when enabled)
How-to: monitor an artist How-to: monitor an artist
1. Search for the artist and open their page 1. Search for the artist and open their page
2. Click Watch 2. Click Watch
3. Configure release types and intervals in Configuration → Watch 3. Configure release types and intervals in Configuration → Watch
How-to: download discography How-to: download discography
1. Open the artist page 1. Open the artist page
2. Choose release types (e.g., Albums, Singles, Compilations) 2. Choose release types (e.g., Albums, Singles, Compilations)
3. Click Download All; track progress in Queue and History 3. Click Download All; track progress in Queue and History
Backend endpoints used: Backend endpoints used:
- GET `/api/artist/info?id=...&limit=20&offset=...` (metadata + paged albums) - GET `/api/artist/info?id=...&limit=20&offset=...` (metadata + paged albums)
- GET `/api/artist/download/{artist_id}?album_type=album,single,compilation` (queue discography) - 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` - PUT `/api/artist/watch/{artist_id}` / DELETE `/api/artist/watch/{artist_id}` / GET `/api/artist/watch/{artist_id}/status`

View File

@@ -31,14 +31,17 @@ Open Configuration in the web UI. Tabs:
- Change password, view role and email - Change password, view role and email
Quality formats (reference): Quality formats (reference):
- Spotify: OGG 96k/160k/320k (320k requires Premium) - Spotify: OGG 96k/160k/320k (320k requires Premium)
- Deezer: MP3 128k/320k (320k may require Premium), FLAC (Premium) - Deezer: MP3 128k/320k (320k may require Premium), FLAC (Premium)
- Conversion: MP3/FLAC/AAC/OGG/OPUS/WAV/ALAC with custom bitrate - Conversion: MP3/FLAC/AAC/OGG/OPUS/WAV/ALAC with custom bitrate
Fallback system: Fallback system:
- Configure primary and fallback services - Configure primary and fallback services
- Automatically switches if primary fails (useful for geo/account limits) - Automatically switches if primary fails (useful for geo/account limits)
Notes: Notes:
- Explicit content filter applies in pages (e.g., hides explicit tracks on album/playlist views) - Explicit content filter applies in pages (e.g., hides explicit tracks on album/playlist views)
- Watch system must be enabled before adding items - Watch system must be enabled before adding items

View File

@@ -10,6 +10,7 @@ See all downloads and their outcomes.
- Re-queue failures from the UI - Re-queue failures from the UI
Backend endpoints used: Backend endpoints used:
- GET `/api/history?download_type=&status=&limit=&offset=` - GET `/api/history?download_type=&status=&limit=&offset=`
- GET `/api/history/{task_id}` (entry) - GET `/api/history/{task_id}` (entry)
- GET `/api/history/{task_id}/children` (child tracks) - GET `/api/history/{task_id}/children` (child tracks)

View File

@@ -16,5 +16,6 @@ Authentication is optional. When enabled:
- Reset user passwords - Reset user passwords
Where to find it in the UI: Where to find it in the UI:
- User menu (top-right) → Profile settings - User menu (top-right) → Profile settings
- Configuration → User Management (admin) - Configuration → User Management (admin)

View File

@@ -17,6 +17,7 @@ How-to: download a playlist
3. Monitor progress in the Queue; results appear in History 3. Monitor progress in the Queue; results appear in History
Backend endpoints used: Backend endpoints used:
- GET `/api/playlist/metadata?id=...` (metadata only) - GET `/api/playlist/metadata?id=...` (metadata only)
- GET `/api/playlist/tracks?id=...&limit=50&offset=...` (paged tracks) - 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/info?id=...&include_tracks=true` (full info when needed)

View File

@@ -11,6 +11,7 @@ Find a track via search or open a track page.
- Artists, album, duration, popularity - Artists, album, duration, popularity
Backend endpoints used: Backend endpoints used:
- GET `/api/track/info?id=...` (metadata) - GET `/api/track/info?id=...` (metadata)
- GET `/api/track/download/{track_id}` (queue download) - GET `/api/track/download/{track_id}` (queue download)
- GET `/api/progress/stream` (live queue updates) - GET `/api/progress/stream` (live queue updates)

View File

@@ -12,6 +12,7 @@ Enable the watch system in Configuration → Watch first.
- Trigger a manual check if you want immediate processing - Trigger a manual check if you want immediate processing
Backend endpoints used: Backend endpoints used:
- Artists: PUT/DELETE/GET status under `/api/artist/watch/*` - Artists: PUT/DELETE/GET status under `/api/artist/watch/*`
- Playlists: PUT/DELETE/GET status under `/api/playlist/watch/*` - Playlists: PUT/DELETE/GET status under `/api/playlist/watch/*`
- Manual triggers: POST `/api/artist/watch/trigger_check` and `/api/playlist/watch/trigger_check` - Manual triggers: POST `/api/artist/watch/trigger_check` and `/api/playlist/watch/trigger_check`