We want YOU to edit the F.A.Q.!

[Julian-O]

There are some changes to the documentation gradually rolling out across the repositories.

One is that we are establishing FAQ documents, consistently, across each of the major Kivy repos.

New Kivy Framework FAQ
New PyJNIus FAQ
New Buildozer FAQ
New Plyer FAQ

Note that the new FAQs are not part of the Sphinx reStructuredText (RST) documents. Instead, they are MarkDown files plonked right in the root directory of the repository!

There are two major reasons for this:

• The questions related to a release generally come after the release. We want to be able to link users to the freshest FAQ, even if they are using older versions of software.

• We want experts to feel comfortable about editing the FAQ at any time. FAQs are a low-formality document that can be quickly added to with the minimum of fuss. MarkDown is easier and more widely known.

So, now it is your turn. What are the most common support requests? What are the most common misunderstandings? What had you stuck for a long time? Please add your questions and answers to the new FAQs, using the contribution guidelines.

Suggestions:

• FAQs work best when they are short and to the point. Someone has a problem. They want the solution, and to move on. If there is further reading, include links to the RST documentation and other sources.

• People are going to find their answers by searching. Try to use the keywords that are going to be searching for, especially error text.

• Go out and mine for ideas - StackOverflow, Reddit, Discord, the old Google Groups, the old Kivy Wiki. However, don't plagiarise - link to your sources - and don't infringe on copyright.

  In particular, Robert Flatt's excellent Android for Python Users document is not freely licensed, and we don't have his permission to steal sections. Use it for inspiration, but don't copy his words. Respect his copyright and contributions to the project.

The Kivy products are very powerful tools, but fraught with ways for new users to shoot themselves in the proverbial feet. FAQs can be powerful ways to help them prevent such accidents, and also help us by having something to quickly point to when they do. Please help us make the FAQs useful, up-to-date documents.