Hi Everyone,
Having the manual in a separate github project doesn't help to sync code merge and manual update.
Other projects manage this by asking contributors in PR to update manual before accepting merge. No manual update, no code merge. (at least for each code change that change the interface or behaviour)
is it possible to move the manual inside the same github project ? sb Le 23/06/2017 à 19:28, Sean M. Pappalardo - D.J. Pegasus a écrit :
Hello everyone. With all of the recent development going on, especially the GSoC projects, I want to remind everyone that it is extremely important that the user manual is also updated whenever new features are merged to master so we can release quickly. (Otherwise waiting on user manual updates will block the process.) And documenting how the feature works is of course much easier when you've just recently worked on it. The manual is also stored in GitHub here: https://github.com/mixxxdj/manual It uses reStructuredText and you can clone it just like any code base or edit it right on GitHub. See the ReadMe at the link for details. We are able to generate Web pages (http://mixxx.org/manual/latest/) and PDFs (https://mixxx.org/manual/latest/Mixxx-Manual.pdf) from the same reST source. Thanks everyone for helping with this as the project leads continue to fix the release process. Sincerely, Sean M. Pappalardo "D.J. Pegasus" Mixxx Developer - Controller Specialist
------------------------------------------------------------------------------ Check out the vibrant tech community on one of the world's most engaging tech sites, Slashdot.org! http://sdm.link/slashdot _______________________________________________ Get Mixxx, the #1 Free MP3 DJ Mixing software Today http://mixxx.org Mixxx-devel mailing list Mixxx-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/mixxx-devel
