chore(docs): fix formatting
This commit is contained in:
@@ -12,6 +12,7 @@ Open an album from search or artist page.
|
||||
- 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)
|
||||
@@ -12,16 +12,19 @@
|
||||
- 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
|
||||
|
||||
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`
|
||||
@@ -31,14 +31,17 @@ Open Configuration in the web UI. Tabs:
|
||||
- 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
|
||||
|
||||
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
|
||||
@@ -10,6 +10,7 @@ See all downloads and their outcomes.
|
||||
- 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)
|
||||
|
||||
@@ -16,5 +16,6 @@ Authentication is optional. When enabled:
|
||||
- Reset user passwords
|
||||
|
||||
Where to find it in the UI:
|
||||
|
||||
- User menu (top-right) → Profile settings
|
||||
- Configuration → User Management (admin)
|
||||
@@ -17,6 +17,7 @@ How-to: download a playlist
|
||||
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)
|
||||
|
||||
@@ -11,6 +11,7 @@ Find a track via search or open a track page.
|
||||
- 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)
|
||||
@@ -12,6 +12,7 @@ Enable the watch system in Configuration → Watch first.
|
||||
- Trigger a manual check if you want immediate processing
|
||||
|
||||
Backend endpoints used:
|
||||
|
||||
- Artists: PUT/DELETE/GET status under `/api/artist/watch/*`
|
||||
- Playlists: PUT/DELETE/GET status under `/api/playlist/watch/*`
|
||||
- Manual triggers: POST `/api/artist/watch/trigger_check` and `/api/playlist/watch/trigger_check`
|
||||
Reference in New Issue
Block a user