Qt5/Documentation: Difference between revisions

Revision as of 10:07, 17 October 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/RenewalProjectOverview - List of existing non-class-documentation pages triaged to see if they contain outdated information etc.

Qt5/Documentation/OverviewClassification - List of non-class documentation grouped into topics and sub-topics

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/OverviewStructure - New high-level structure of the Qt documentation set with brief introduction to each section.

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 http://qt-project.org/wiki/Category:Developing_Qt::Documentation

@@ Line 3: / Line 3: @@
 better documentation for Qt. The following pages provides more details about the project, listing "things to be done (fixme)" with some guidelines.
-[[Qt5/Documentation/RenewalProjectOverview]] - List of existing non-class-documentation pages triaged to see if they contain outdated information etc.
+* [[Qt5/Documentation/RenewalProjectOverview]] - List of existing non-class-documentation pages triaged to see if they contain outdated information etc.
-[[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/OverviewClassification]] - List of non-class documentation grouped into topics and sub-topics
-[[Qt5/Documentation/OverviewClassification]] - List of non-class documentation grouped into topics and sub-topics
+* [[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/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/OverviewStructure]] - New high-level structure of the Qt documentation set with brief introduction to each section.
+* [[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/OverviewStructure]] - New high-level structure of the Qt documentation set, with overviews organized logically.
 For information about Qt's documentation processes such as who can approve or edit, visit http://qt-project.org/wiki/Category:Developing_Qt::Documentation