Skip to content

Commit 324b5d4

Browse files
committed
Enable myst notes boxes, improve import tracks docs
1 parent 1b485e0 commit 324b5d4

File tree

2 files changed

+16
-6
lines changed

2 files changed

+16
-6
lines changed

sphinx/source/MANUAL.md

+15-6
Original file line numberDiff line numberDiff line change
@@ -122,19 +122,28 @@ To import all releases including all tracks in your collection use the tracks su
122122

123123
`dsc import tracks`
124124

125+
:::{attention}
126+
Importing track details is a requirement for using the [suggest](#the-suggest-command) and the [mix](#the-mix-command) command.
127+
:::
128+
129+
130+
### Importing further track details from MusicBrainz
131+
125132
To add additional data to your tracks from MusicBrainz/AcousticBrainz (key, BPM, links) use the brain subcommand. Your releases will then be "matched" one-by-one with MusicBrainz - this is not the easiest task for DiscoDOS, several things have to be "tried" to get it right. Differences in spelling/wording of catalog number, artists, title, track numbers, track names in MusicBrainz compared to Discogs are the main reason why it takes that long:
126133

127134
_**Note: This process will take hours. Best you let it run "overnight"**_
128135

129136
`dsc import brainz`
130137

131-
A slightly quicker but less effective method is using the --quick option:
138+
:::{note}
139+
The [suggest](#the-suggest-command), [mix](#the-mix-command) and [links](#the-links-command) commands make use of this type of imported data.
140+
:::
132141

133-
`dsc import brainz -q`
142+
A slightly quicker but less effective method is using the `--quick` option:
134143

135-
Also remember that it's unlikely that MusicBrainz even *has* an entry for each of your records. Discogs still *is* the most complete music database on earth compared to others. Most definitely when it comes to Vinyl records.
144+
`dsc import brainz -q`
136145

137-
Also note that often it happens that a MusicBrainz track _can_ be "matched" but AcousticBrainz does not have an entry for it yet.
146+
It's unlikely that MusicBrainz has entries for all of your records (it has its many strengths but when it comes to Vinyl, Discogs still is the most complete database on earth). Also often it happens that even though "matching" to a MusicBrainz track _is_ successful, AcousticBrainz does not have an entry for it anyway. Unfortunately adding to data to AcousticBrainz is not possible anymore - [Read why here!](#acousticbrainz-support-is-deprecated).
138147

139148
If for some reason you can't complete the run (connection problems, having to switch off your computer, ...) you can resume the process at a later time. DiscoDOS spits out regularly how many tracks have been matched already and how many are to be done. This will resume the matching at track number 2500 in your collection:
140149

@@ -593,7 +602,7 @@ So to query this field, use `dsc ls sold=1`. The result will include items that
593602

594603
## AcousticBrainz support is deprecated
595604

596-
Since its initial 1.0 release, for one of its main features - muscial key/BPM finding - DiscoDOS relies heavily on MusicBrainz and AcousticBrainz (which provided key/BPM data) As of February 2022 unfortunately [the AcousticBrainz project was shut down](https://blog.metabrainz.org/2022/02/16/acousticbrainz-making-a-hard-decision-to-end-the-project/), as a consequence DiscoDOS theoretically can't fetch key and BPM anymore. It appears though that the MetaBrainz foundation let the service run but only does not allow submitting new data to it. This might change anytime soon. Currently it is still possible to at least find "some" of your tracks' key and BPM data, thus these features were not removed from DiscoDOS yet.
605+
Since its initial 1.0 release, for one of its main features - musical key and BPM finding - DiscoDOS relied heavily on MusicBrainz and AcousticBrainz (which provided key/BPM data). As of February 2022 unfortunately [the AcousticBrainz project was shut down](https://blog.metabrainz.org/2022/02/16/acousticbrainz-making-a-hard-decision-to-end-the-project/) and as a consequence, DiscoDOS _theoretically_ can't fetch key and BPM anymore. It appears though that the MetaBrainz foundation let the service run, but forbids submitting _new_ data to it. This might change anytime soon but at the time of writing this, it is still possible for DiscoDOS to use the service.
597606

598607
Ideas on how DiscoDOS could solve this problem [in the website's roadmap chapter](https://discodos.jojotodos.net/#roadmap).
599608

@@ -682,4 +691,4 @@ WebDAV:
682691

683692
`discosync -t w --restore`
684693

685-
or short: `discosync -t w -r`
694+
or short: `discosync -t w -r`

sphinx/source/conf.py

+1
Original file line numberDiff line numberDiff line change
@@ -139,4 +139,5 @@
139139
myst_heading_anchors = 7
140140
myst_enable_extensions = [
141141
"strikethrough",
142+
"colon_fence",
142143
]

0 commit comments

Comments
 (0)