docs: troubleshooting section + hardware-first intro - #28
Merged
Conversation
The three problems people hit most (the CDJ waveform-color quirk, the post-upgrade re-analysis pass, and the rekordbox slot collision), plus how to collect useful logs for a bug report now that the default log level is quiet. About-the-project questions point at the website FAQ.
The intro paragraph led with mechanism ("serves music files to CDJs
over the Pro DJ Link protocol"); it now leads with the capability -
load tracks from your PC straight onto CDJ/XDJ hardware with no
rekordbox, no USB sticks, no export step - matching the framing of the
website FAQ. Same facts, same length, mechanism and features follow.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What & why
Two README commits, paired with the FAQ that just went up on the website.
The intro paragraph led with mechanism ("serves music files to CDJs over the Pro DJ Link protocol"); it now leads with what the app does for a DJ with hardware: load tracks from your PC straight onto Pioneer CDJ/XDJ decks, with no rekordbox, no USB sticks, and no export step. Same facts and length as before; the two appearance modes, the DJM mention, analysis, the web UI, and one-click import all stay.
A new Troubleshooting section covers the three problems people actually hit: the CDJ waveform-color quirk that blanks the scrolling waveform for network sources, the expected one-time re-analysis pass after upgrades that bump the analysis cache version, and the rekordbox slot collision that makes CDJs silently stop loading tracks when two rekordbox sources share the network. It closes with how to collect useful logs for a bug report, which is worth saying now that the default log level is quiet. About-the-project questions point at the website FAQ instead of being duplicated, so there is one source of truth for each kind of content: the site answers "what is this", the README fixes "why is it doing that".
Hardware testing
Checklist
go build ./...,go vet ./..., andgo test ./...passgofmt -l .is cleanGPL-3.0-or-later) (n/a, no new files)