Skip to content

Commit 891e591

Browse files
committed
docs: Reorganize doc contents
1 parent 2540ed3 commit 891e591

39 files changed

Lines changed: 267 additions & 2989 deletions

docsite/docs/FAQ.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ First, turn on **debug** logging for multi-scrobbler by setting the environmenta
3333

3434
##### Check Host name and URL
3535

36-
The URLs examples in the [configuration](configuration/configuration.mdx) documentation assume you are running Webscrobbler/LFM Endpoint on the same server as multi-scrobbler. If these are not the same machine then you need to determine the IP address or domain name that multi-scrobbler is reachable at and use that instead of `localhost` when configuring these sources. **This is likely the same host name that you would use to access the web interface for multi-scrobbler.**
36+
The URLs examples in the [configuration](/configuration#base-url) documentation assume you are running Webscrobbler/LFM Endpoint on the same server as multi-scrobbler. If these are not the same machine then you need to determine the IP address or domain name that multi-scrobbler is reachable at and use that instead of `localhost` when configuring these sources. **This is likely the same host name that you would use to access the web interface for multi-scrobbler.**
3737

3838
EX `http://localhost:9078/api/webscrobbler` -> `http://192.168.0.140:9078/api/webscrobbler`
3939

@@ -70,7 +70,7 @@ Error: Could not send the specified request to browse. Status code: 401
7070

7171
then YTM has invalidated your authentication.
7272

73-
First, ensure you are NOT using [YoutubeTV authentication.](configuration/configuration.mdx?ytmAuth=ytt#youtube-music) If you completed authentication by entering a "User Code" you are using YoutubeTV which has stopped working. You should reauthenticate using **Cookies** or **Custom OAuth.**
73+
First, ensure you are NOT using [YoutubeTV authentication.](/configuration/sources/youtube-music?ytmAuth=ytt#authentication) If you completed authentication by entering a "User Code" you are using YoutubeTV which has stopped working. You should reauthenticate using **Cookies** or **Custom OAuth.**
7474

7575
#### When using OAuth Client Authentication
7676

@@ -80,7 +80,7 @@ Refresh your authentication by using the **(Re)authenticate** link from MS's web
8080

8181
The library MS uses relies on scraping the YTM site by using cookies from your actual browser to pretend it is a browser. It does its best to keep these up to date but since this is not an official way to access the service YTM may invalidate your access _to the authenticated session_ at any time. How this is triggered is unknown and not something multi-scrobbler can control. You can help limit the chance of your session being invalidated by [getting the cookie from an Incognito/Private Session](https://github.com/LuanRT/YouTube.js/issues/803#issuecomment-2504032666) and then immediately closing the browser afterwards.
8282

83-
To re-authenticate MS [follow the YTM instructions to retrieve a new set of cookies for multi-scrobbler](configuration/configuration.mdx?ytmAuth=cookie#youtube-music) and then restart MS to potentially resolve the problem.
83+
To re-authenticate MS [follow the YTM instructions to retrieve a new set of cookies for multi-scrobbler](/configuration/sources/youtube-music?ytmAuth=cookie#authentication) and then restart MS to potentially resolve the problem.
8484

8585
## Configuration Issues
8686

@@ -108,7 +108,7 @@ Multi-scrobbler works the same was the official Spotify-Last.fm integration work
108108

109109
The Google Cast integration relies on a few common fields in the data it receives from your casting device. Every platform that can cast (Spotify, Pandora, etc...) *should* use these fields the same but there are slight differences between their implementations that may confuse multi-scrobbler. Specific platforms may also return more information in non-common fields that are undocumented.
110110

111-
To diagnose these issues you [**must enable payload logging**](configuration/configuration.mdx#cast-troubleshooting) for your google cast Source, run MS, and then include logs with this output from that run. Without the raw data logged from your cast device it will be nearly impossible to resolve your issue.
111+
To diagnose these issues you [**must enable payload logging**](/configuration/sources/google-cast#cast-troubleshooting) for your google cast Source, run MS, and then include logs with this output from that run. Without the raw data logged from your cast device it will be nearly impossible to resolve your issue.
112112

113113
### Google Cast device does not track media
114114

@@ -120,17 +120,17 @@ MS logs will tell you what type the media is reported as with lines like:
120120
My Artist - Example Track has 'unknown' media type and allowUnknownMedia=false, will not track
121121
```
122122

123-
Refer to [Allow Unknown Media Type](configuration/configuration.mdx#allow-unknown-media-type) section to fix this
123+
Refer to [Allow Unknown Media Type](/configuration/sources/google-cast#allow-unknown-media-type) section to fix this
124124

125125
```
126126
My Artist - Example Track has 'movie' media type so will not track
127127
```
128128

129-
Refer to [Force Media Tracking](configuration/configuration.mdx#forcing-media-tracking) section to fix this
129+
Refer to [Force Media Tracking](/configuration/sources/google-cast#forcing-media-tracking) section to fix this
130130

131131
### VLC is not scrobbling fields correctly
132132

133-
Before reporting an issue turn on metadata logging in the MS VLC configuration, [see the VLC documentation.](configuration/configuration.mdx#vlc-information-reporting)
133+
Before reporting an issue turn on metadata logging in the MS VLC configuration, [see the VLC documentation.](/configuration/sources/vlc#vlc-information-reporting)
134134

135135
### Youtube Music misses or duplicates scrobbles
136136

@@ -169,7 +169,7 @@ In your YTM configuration (`ytmusic.json`) add `logDiff` under `options` like th
169169
or set either ENVs:
170170

171171
* `YTM_LOG_DIFF=true`
172-
* [`DEBUG_MODE=true`](configuration/configuration.mdx?#debug-mode)
172+
* [`DEBUG_MODE=true`](/configuration#debug-mode)
173173

174174
This will cause MS to log YTM history changes similar to this:
175175

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"label": "Configuration",
3-
"position": 4,
3+
"position": 5,
44
"link": {
5-
"type": "generated-index",
6-
"description": "Configuring Multi-Scrobbler and examples"
5+
"type": "doc",
6+
"id": "configuration/configuration"
77
}
88
}

docsite/docs/configuration/clients/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22
"label": "Scrobble Clients",
33
"link": {
44
"type": "doc",
5-
"id": "configuration/clients/overview"
5+
"id": "configuration/clients/clients"
66
}
77
}

docsite/docs/configuration/clients/overview.mdx renamed to docsite/docs/configuration/clients/clients.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ A **Client** is an application that stores the historical information about what
1616
| [Listenbrainz](/configuration/clients/listenbrainz) ||
1717
| [Koito](/configuration/clients/koito) ||
1818
| [Maloja](/configuration/clients/maloja) ||
19-
| [Rocksky](/configuration/clients/rockysky) ||
19+
| [Rocksky](/configuration/clients/rocksky) ||
2020

2121
## Features
2222

docsite/docs/configuration/clients/rocksky.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ toc_min_heading_level: 2
44
toc_max_heading_level: 5
55
---
66

7-
[**Rocksky**](https://docs.rocksky.app/) is music tracking and discovery platform built on the AT Protocol (Bluesky). It is compatible with the Listenbrainz API and so can be as a multi-scrobbler [Listenbrainz Client](#listenbrainz) using a custom URL.
7+
[**Rocksky**](https://docs.rocksky.app/) is music tracking and discovery platform built on the AT Protocol (Bluesky). It is compatible with the Listenbrainz API and so can be as a multi-scrobbler [Listenbrainz Client](/configuration/clients/listenbrainz) using a custom URL.
88

99
You will need a [Bluesky](https://bsky.app/) account to use Rockysky.
1010

0 commit comments

Comments
 (0)