Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move Hercules DJControl MP3 e2 / MP3 LE / Glow manual from wiki #697

Open
wants to merge 1 commit into
base: 2.4
Choose a base branch
from

Conversation

loziniak
Copy link

No description provided.

@ronso0
Copy link
Member

ronso0 commented Oct 25, 2024

Thank you for this PR.
Please sign the Mixxx Contributor Agreement and comment here when you have done so. It gives us permission to distribute your contribution under the GPL v2 or later license and the Apple Mac App Store. It is also helpful for us to have contact information for contributors in case we may need it in the future.

I didn't look at the changes, yet, though I noticed the CI complaints. I think it's just a spelling issue (here https://github.com/mixxxdj/manual/actions/runs/11517598740/job/32073901640?pr=697#step:4:105, also adjust the column markers after adding the 'p' otherwise Sphinx will complain).

You can catch issues like this early if you install pre-commit locally, as mentioned in the prep instructions https://github.com/mixxxdj/manual#editing-the-manual-using-git-recommended

Let us know if you need help.

@ronso0
Copy link
Member

ronso0 commented Oct 25, 2024

Some thoughts:
(please don't take them as demands / requirements for merging, but I think instead of an almost 1:1 copy we should polish this a bit in order to make the manual addition really helpful)

  • I think the "Mapping description (by knob/button)" section should be placed before the 'by-function' sections
  • IMO the full-size images for the 'by-function' sections make the page unnecessarily long. Wouldn't smaller overviews suffice?
  • 'by-function' sections: I think the essential information could be more accessible, eg. we could merge & swap the colums so it's [number + control] | function. There is also the :hwlabel: tag:
    :hwlabel:`(button label)`
    

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants