[prev in list] [next in list] [prev in thread] [next in thread]
List: kde-community
Subject: Re: KDE Developer Documentation
From: Valorie Zimmerman <valorie.zimmerman () gmail ! com>
Date: 2019-12-28 5:36:07
Message-ID: CACpu024EzTy4m4rdR5yYJRFxE+SGk6dFgni+fMhPCMXcyOnTZA () mail ! gmail ! com
[Download RAW message or body]
On Fri, Dec 27, 2019 at 6:53 PM Juan Carlos Torres <jucato@kdemail.net>
wrote:
> On Sat, Dec 28, 2019, 08:39 Olivier Churlaud <olivier@churlaud.com> wrote:
>
>> Hi,
>>
>> At CERN we didn't speak about this, except with the Plasma team who spoke
>> about having a cookbook based on git containing all the code and
>> explanations.
>>
>> Sebastian Klüger was the one who raised the idea. I have no idea if
>> something came out of this.
>>
>
> I wasn't made aware of any development in that matter when I asked Plasma
> devs. The problem still stands that QML and JS documentation seem difficult
> to properly do in Doxygen even with the QML extension.
>
> For frameworks we wanted to break the idea that you need to take all kf5
>> libs to use one, hence we didn't want to promote too much the transverse
>> tutorial. This idea can be challenged, though.
>>
>
> I think there's room for both. The Frameworks documentation definitely
> need to be standalone and complete, including examples. But there will also
> be some need for tutorials and guides that revolve around themes, topics,
> and applications. It's less about "you need all kf5 libs" and more about
> "you can connect and use multiple kf5 libs this way to make Qt
> applications". These would be higher-level documentation rather than
> Framework-specific.
>
> Whether they can or should be in the apidox may be a different discussion.
> I'll try to review the tutorials and see which can go where and also think
> of tutorials and guides that may not be a direct fit for apidocs.
>
By the way, the Frameworks Cookbook was written and is still available:
https://community.kde.org/Books for more information. And we did do it in
git!
Valorie
--
http://about.me/valoriez - pronouns: she/her
[Attachment #3 (text/html)]
<div dir="ltr"><div dir="ltr">On Fri, Dec 27, 2019 at 6:53 PM Juan Carlos Torres \
<<a href="mailto:jucato@kdemail.net">jucato@kdemail.net</a>> \
wrote:<br></div><div class="gmail_quote"><blockquote class="gmail_quote" \
style="margin:0px 0px 0px 0.8ex;border-left:1px solid \
rgb(204,204,204);padding-left:1ex"><div dir="auto"><div><div class="gmail_quote"><div \
dir="ltr" class="gmail_attr">On Sat, Dec 28, 2019, 08:39 Olivier Churlaud <<a \
href="mailto:olivier@churlaud.com" target="_blank">olivier@churlaud.com</a>> \
wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px \
0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div>Hi,<br><br>At \
CERN we didn't speak about this, except with the Plasma team who spoke about \
having a cookbook based on git containing all the code and \
explanations.<br><br>Sebastian Klüger was the one who raised the idea. I have no \
idea if something came out of this.<br></div></blockquote></div></div><div \
dir="auto"><br></div><div dir="auto">I wasn't made aware of any development in \
that matter when I asked Plasma devs. The problem still stands that QML and JS \
documentation seem difficult to properly do in Doxygen even with the QML \
extension.</div><div dir="auto"><br></div><div dir="auto"><div \
class="gmail_quote"><blockquote class="gmail_quote" style="margin:0px 0px 0px \
0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div>For frameworks we \
wanted to break the idea that you need to take all kf5 libs to use one, hence we \
didn't want to promote too much the transverse tutorial. This idea can be \
challenged, though.<br></div></blockquote></div></div><div dir="auto"><br></div><div \
dir="auto">I think there's room for both. The Frameworks documentation definitely \
need to be standalone and complete, including examples. But there will also be some \
need for tutorials and guides that revolve around themes, topics, and applications. \
It's less about "you need all kf5 libs" and more about "you can \
connect and use multiple kf5 libs this way to make Qt applications". These would \
be higher-level documentation rather than Framework-specific.</div><div \
dir="auto"><br></div><div dir="auto">Whether they can or should be in the apidox may \
be a different discussion. I'll try to review the tutorials and see which can go \
where and also think of tutorials and guides that may not be a direct fit for \
apidocs.</div></div></blockquote><div><br></div><div>By the way, the Frameworks \
Cookbook was written and is still available: <a \
href="https://community.kde.org/Books">https://community.kde.org/Books</a> for more \
information. And we did do it in git!</div><div><br></div><div>Valorie</div><div> \
</div></div>-- <br><div dir="ltr" class="gmail_signature"><div dir="ltr"><div><a \
href="http://about.me/valoriez" target="_blank">http://about.me/valoriez</a> - \
pronouns: she/her<br></div></div></div></div>
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic