Qt5/Documentation: Difference between revisions

From KDE Community Wiki
No edit summary
No edit summary
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 the documentation for it. We've started a documentation renewal project to updated/remove
outdated information from the documentation, and also fill in information gaps. We welcome your support in this project so that we can continue to provide
better documentation for Qt. The following pages provides more details about the project, listing "things to be done (fixme)".


[[Qt5/Documentation/ExampleList]] -  
[[Qt5/Documentation/RenewalProjectOverview]] - List of existing non-class-documentation pages triaged to see if they contain outdated information etc.


[[Qt5/Documentation/RenewalProjectOverview]] - List of non-class-documentation pages that we have. 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
Line 9: Line 11:
[[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]] - Main page which lists the topics and the relevant overviews.
[[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
For information about Qt's documentation processes such as who can approve or edit, visit http://qt-project.org/wiki/Category:Developing_Qt::Documentation

Revision as of 08:55, 17 October 2012

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

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/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 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