Wasn’t meant as criticism, sorry.
That’s also useful, thanks.
Or maybe I just don’t understand how it works well enough. As you see the are a lot of things that I didn’t know or had misunderstood.
There are also not enough people reviewing (or perhaps you include that in writing). This is not a criticism of anyone, but when doc PRs sit for months without review it is difficult to feel motivated to write more.
Also because the bigger we make it (the shortcuts section specifically) the more people will give up reading it. I don’t know how to make it both comprehensive and easy to understand (and I still don’t understand a lot of it myself). So I tried to find a happy medium. IMO if we’re going to add more to it, we might be better off creating a separate “advanced use” page or something.
In some ways, reviewing is harder than writing, because we still need to verify what’s written and engage in back-and-forth when things aren’t clear. I will try to find some time before the next release to do some more reviews / write some more content.
Absolutely agree. No-one should feel pressured into reviewing!
Apologies if this is known to many, but it’s not clear to me.
If I wanted to try to improve some parts of docs, would I just go the PR way or is there a different process in place?
This page explains how the docs should be written, but not how contributions should be delivered.
Yes, a PR is the way to go.
There is a step-by-step guide here: A plea for help writing the docs - #22 by hatsnp
And a list of darktable issues needing docs can be found here: Pull requests · darktable-org/darktable · GitHub
Thanks.
If they are not already there (and I did not find them) I would add these pointers to the docs so that this information is more discoverable.
Why not make that your first PR?
![]()
One small additional tweak: Set a shortcut for the search bar (I chose STRG+F; I never use it to hide the bottom bar). This saves me fiddeling with the mouse to get to the search bar (action is named “search modules”).
I use Ctrl-L for that, like the browser’s address bar.
I use / because I am nerdier ![]()