ronso0
commented
4 weeks ago 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)`
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.