Qt5/Documentation: Difference between revisions

Latest revision as of 13:32, 1 November 2012

With Qt 5 being close to the final release, we need to improve documentation for it. We've started a documentation renewal project to updated/remove outdated information, and also fill in information gaps. We welcome your support in this project so that we continue to provide better documentation for Qt. The following pages provides more details about the project, listing "things to be done (fixme)" with some guidelines.

Qt5/Documentation/OverviewClassification - List of non-class documentation grouped into topics and sub-topics as per the new structure, Qt5/Documentation/OverviewStructure.

Qt5/Documentation/RenewalProjectClassList - List of class documentation pages that we have. We need to go through them to see that they accurately represent Qt 5.

Qt5/Documentation/ExampleList - List of all the examples we have, to help contributors triage and retain only those examples which are relevant in Qt 5 context.

For information about Qt's documentation processes such as who can approve or edit, visit

@@ Line 1: / Line 1: @@
-With Qt 5 being close one task left is improving our documentation. Everyone is invited to participate. For this reason we created two pages listing "things to be done (fixme)".
+With Qt 5 being close to the final release, we need to improve documentation for it. We've started a documentation renewal project to updated/remove
+outdated information, and also fill in information gaps. We welcome your support in this project so that we continue to provide
+better documentation for Qt. The following pages provides more details about the project, listing "things to be done (fixme)" with some guidelines.
-[[Qt5/Documentation/ExampleList]] -
+* [[Qt5/Documentation/OverviewClassification]] - List of non-class documentation grouped into topics and sub-topics as per the new structure, [[Qt5/Documentation/OverviewStructure]].
-[[Qt5/Documentation/RenewalProjectOverview]] - List of non-class-documentation pages that we have. Triaged to see if they contain outdated information etc.
+* [[Qt5/Documentation/RenewalProjectClassList]] - List of class documentation pages that we have. We need to go through them to see that they accurately represent Qt 5.
-[[Qt5/Documentation/OverviewClassification]] - List of non-class documentation grouped into topics and sub-topics
+* [[Qt5/Documentation/ExampleList]] - List of all the examples we have, to help contributors triage and retain only those examples which are relevant in Qt 5 context.
-[[Qt5/Documentation/RenewalProjectClassList]] - List of class documentation pages that we have. We need to go through them to see that they accurately represent Qt 5.
+For information about Qt's documentation processes such as who can approve or edit, visit
+* [http://qt-project.org/wiki/Category:Developing_Qt::Documentation Qt Documentation wiki]
-[[Qt5/Documentation/OverviewStructure]] - Main page which lists the topics and the relevant overviews.
+* [http://qt-project.org/wiki/Qt5DocumentationProject Qt 5 documentation information and structure]
+* [http://qt-project.org/wiki/Building_Qt_Documentation Building Qt documentation]
-For information about Qt's documentation processes such as who can approve or edit, visit http://qt-project.org/wiki/Category:Developing_Qt::Documentation