Newbie questions for documentation

[Marco Martin]

I've put inline some of the answers that could be given in one line or
so, and noted those that will still need a bit of consenus to be
properly answered,
but yeah, answers to all of this would be a good start. do you
envision it more like a general site structure or a separate FAQ page?

On Mon, May 6, 2019 at 2:05 PM Juan Carlos Torres <jucato at kdemail.net> wrote:
>
> Greetings!
>
> As discussed in the first Kirigami docs meeting, I would be throwing some newbie questions as possible points for building the docs. I'm also adding a few notes on those questions. I'm sure some of these might already be on Marco's mind but It's probably still good to have them written down somewhere for reference.
>
> 1. What is Kirigami?
> - Probably not a common question since those approaching it will have a vague idea what it's about already. Still bears mentioning on the front page and docs intro, though.

I would like keeping the duality it was supposed to have at the very
beginning, but that

* An UI design specification which includes first of all the HIG, and
to a lesser extent, the look (so, on selected platforms only, Breeze)
* A framework which makes easy for QML applications to implement such
design, implemented *on top* on QtQuickControls2 (complementary, not
concurrent), and those new docs should be mostly about this part, even
tough with many recalls to the HIG docs

> 2. What can I do with Kirigami or what can I use it for?
> - Basically Kirigami's best/unique features as well as examples of what's possible with Kirigami

would put quite some stress on convergence?

> 3. What can I *not* do with Kirigami or what isn't Kirigami for?
> - Limitations of the framework (Android Material Design, for example).

if the target is a gui app.. pretty much always worth to use it i guess..
becomes not so useful when the target is android and android only i
guess (as in, at that point you may well use java and save
integration/deployoment nightmares)

> 4. What do I need to know to use Kirigami?
> - This is more on technical knowledge/familiarity
links to Qt/QML documentation?


> 5. Can I use Kirigami to develop an Android app only?
> - Yes, but ...
>
> 6. Can I use Kirigami to develop a desktop app only?
> - Yes, but ...
>
> 7. How do I make a convergent app?
> - What is a convergent app? What would be its features and limitations?
>
> 8. What are the components/UI pieces provided by Kirigami
> - The controls/"widgets" that Kirigami adds on top of Qt Quick, etc.
>
> 9. What do I do if I need a control that's not available in Kirigami
> - Extending Kirigami or Kirigami apps, probably an advanced topic
>
> 10. What do I need to get started?
> - Mostly the setup part, what libraries are needed, toolchains, etc.
>
> 11. How do I build and deploy to Android?
> - Setting up for Android deployment
>
> 12. Do I need to follow the KDE HIG?
> - Probably sensitive topic, but might be best to set it straight and put it on paper
>
> 13. How do I contribute to Kirigami? What needs to be done to improve it?
> - Information for interested contributors
>
> 14. Not exactly a question but maybe something interesting for developers: a high-level overview of Kirigami, its architecture, how it relates to Qt, KDE (HIG), Plasma, etc.
>
> I hope these can help. Being completely new, I'm not sure how much I can help in writing the docs themselves as those might require familiarity with the software. I'll help whichever way I can within my capabilities. I'll probably be more available around late June as I work through the other KDE dev docs.
>
>
> --
> Regards,
>
> Juan Carlos Torres
> Jucato
> --
> Kirigami mailing list
> Kirigami at kde.org
> http://mail.kde.org/cgi-bin/mailman/listinfo/kirigami