Newbie questions for documentation

Juan Carlos Torres jucato at kdemail.net
Mon May 6 13:05:10 BST 2019


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.

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

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

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

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
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kirigami/attachments/20190506/c7922ad6/attachment.html>


More information about the Kirigami mailing list