displaycal-py3
displaycal-py3 copied to clipboard
eoyilmaz
Proposal for roadmap: Modern documentation
one of the issues with displaycal is the lack of clear documentation, some of it is in cryptic professional language. if we can have clear documentation like this https://mpv.io/manual/master/ would be a big help to new users. Possibly also have a glossary of terms. Also the displaycal website is just hard to read.
this thread is a prime example of the problems users have with Displaycal https://hub.displaycal.net/forums/topic/blue-looks-purple/
I'm not sure if I'm knowledgeable enough to create a documentation for DisplayCAL. But, as you stated documentation and tutorials are very important.
Sorry I wasnt clear, i mean to update the existing formatting and loose forum posts to a modern style, some options are wiki (archlinux wiki style) or the mpv style documentation i linked. the written content would be largely the same. the key difference being better search and readability.
Sure, if we already have a written source for the information we can convert it to RestructuredText format and let Sphinx generate HTML, PDF etc. versions of it.
I'm thinking on helping on this. I see that you self-assigned this recently, do you have specific plans (or have already started building something) for contributing to that documentation?
The Krita manual (https://docs.krita.org/en/general_concepts/colors.html) has a fantastic introduction to color management targeted at users/artists (not developers or color scientists who grok these bits), but falls short on explaining the different options, steps and tradeoffs you encounter when you actually create a profile with DisplayCAL and want to check that it works correctly and use it in other applications ; and the DisplayCAL help is a bit too verbose for most people.
Hey @fxthomas, yeah that would be lovely. I didn't start writing anything, and, although I've a very good understanding of Color Management & Color Theory and very good understanding of OCIO and ACES and also I have a couple of books at hand on Color Management that I can refer to, I might not qualify for writing the docs on this topic. I don't know a lot of things about how ArgyllCMS and DisplayCAL work.
I've a very good understanding of Color Management & Color Theory and very good understanding of OCIO and ACES
I'm a bit more hazy on OCIO and ACES myself (haven't used them for anything practical although I know the underlying theory), but I have worked a lot with display ICC profiles so I can definitely help on these topics.
I will update this thread when I make some progress then!
I'm slowly adding bits and pieces of knowledge here: https://github.com/fxthomas/displaycal-help, let me know what you think of the general structure and the bits I have already written.
I haven't yet gotten to choosing a license: my gut feeling would be to use the GNU Free Documentation License, but it's the first time I'm publishing something like this so I would like to discuss this here first so that it can eventually be integrated.
Licensing is also why I'm not for now copying anything from the main docs at https://displaycal.net: it would be good manners to discuss with Florian first, and I also haven't researched yet which license the original docs use. Low priority at the moment, I'll get to it when I get to it.