Qt Contributors Summit 2019 Program/Qt for Python Documentation

Ideas to improve the docs

• flutter.dev is a good example of documentation

1. Add a Widgets catalog might be useful to beginners;
2. The distribution makes sense, add a first steps link, a link for the widgets, to the API docs, a couple of tutorials;

• A simplified view of the general documentation is missing;
• Looking at the Design Studio documentation there is a new kind of documentation with simple and illustrated steps to get something done;
• Adding an image explaining what is which widget in ta simple interface might be simple;
• WebAssembly might help, you can create an interactive widget that will show you what are the widgets in the layout;
• We can remove the deprecated stuff from the wiki;
• Sometimes documentation isn't in the snippet files;
• Adding tabs on the docs to quickly switch from Qt to Qt for Python is a dream;
• Go through everything is a big work for human inputs, machines can't do much here

1. Maybe we can bribe them with chocolates;

• We should add images to the docs to the tutorials and pictures to the widget gallery, people like it and it's more easy to understand what's happening

1. Maybe we should have a separate repo for images because it'd get too heavy;
2. Make the docs more interactive and give the opportunity to run code in a webpage and generate a screenshot from this code;

• QtNotebooks: for the tutorials. Creating something like this might help the beginners to get involved;
• We should transfer everything from the wiki to the docs;
• Displaying PySide examples inside the QtCreator

1. If you have a second tab to show PySide examples and the person doesn't have PySide installed you can have something inviting people to download PySide2;
2. You can also add it to the templates. Something along the lines "Click here to download PySide2";

• Having .svg animations to show how to start to stuff, how to build qt for python;

Currently what we have

Good things

• The name Qt For Python is a good thing because you don't get in touch with old stuff;

Bad things

• Too confusing;
• The .rst format is a paing and we'd like to change it to .md;