Details
-
Bug
-
Resolution: Done
-
P2: Important
-
5.10.0
-
1df70118583e069bde41d03bc9753cef949b3e39
Description
The Getting Started section is one of the first meetings new Qt developers have with the documentation, perhaps in particular for beginner to intermediate level C++ developers. Under the heading Create your first applications, this section links to Getting Started Programming with Qt Quick. There are several elements that could be improved:
- The introduction states the the example "assumes basic knowledge of Qt C++ compilation procedure" without linking to a part of the documentation that describes this. Searching the online documentation for "Qt compilation procedure" yields no specific or relevant results.
- The text refers to "running qmlscene" without links to further information about qmlscene. New Qt developers are likely not familiar with this application.
- Running the code snippets with qmlscene launched from Qt Creator, leaves the question of which console to look at for log messages. This is not addressed at all.
- The code snippets contain ellipses that signify parts that have been excluded from the snippet, across examples. The text addresses this, but states that the excluded parts are "either introduced earlier in the previous sections or irrelevant to the current code discussion". The documentation should not expect someone reading up on creating their first application with Qt Quick to know what is irrelevant or not.
- POV in the text switches between the first and second person views.
- Code snippets are not self-contained.
There are possibly further issues that I have not uncovered prior to creating this ticket. Consider improving the example, or replacing it with a different (and better?) one.
Attachments
Issue Links
- relates to
-
QTBUG-71142 Provide simple way to build and run "Getting Started Programming with Qt Quick" example
- Closed