State of documentation

Great documentation is important to great projects.
So how does everyone here find zrythm user doc?
What are elements that are missing?
How can we improve it?

I find it quite exhaustive but a bit dry. Some parts may be unclear.

@alex, where do you need help in regards to the doc?

@Openmastering

What are elements that are missing?

there are few new feature missing, and details in many places. I do my best do document everything but I haven’t touched it lately.

you can help by explaining things better or adding missing things! it doesn’t have to be perfect, it’s a thing that can constanly be improved.

you can click “view source” at the top of each page at https://manual.zrythm.org/ and you can see which file it is in the source code. you can then edit that file and either send a patch if you know how to make one, or just send me the edited file and i’ll add it. please post any patches or edited files on redmine using the “Support” tracker: https://redmine.zrythm.org/projects/zrythm/issues/new

you can also help by translating existing documentation on weblate: https://hosted.weblate.org/engage/zrythm/

if you need help or need to discuss, just come to matrix or IRC (or you can ask questions here)

How to make a patch

  1. clone the zrythm repository:
git clone https://git.zrythm.org/git/zrythm
  1. edit the file, for example doc/user/scripting/examples.rst (remember to add your copyright notice at the top, like Copyright (C) 2020 First Name Last name)
git diff > my-change.patch

I should probably explain how to make patches somewhere, maybe in CONTRIBUTING.md