Uploaded image for project: 'Qt'
  1. Qt
  2. QTBUG-90751

Platforms Area Documentation Overhaul

    XMLWordPrintable

Details

    • Epic
    • Resolution: Unresolved
    • P2: Important
    • 6.x
    • None
    • Documentation
    • None
    • Platforms Area Documentation Overhaul

    Description

      As a user of Qt I would like to have easily readable, understandable and findable documentation.

      Currently Qt platforms documentation structure is quite scattered and hard to navigate. For example embedded Linux has two separate documentation places, one for generic embedded Linux and one for Device Creation product. These should be sensibly linked together to make documentation structure clearer. Also it should be verified that documentation is up to date and written in easily followable way. Also Qt Creator documentation should be checked and updated.

      Links to current documentation:

      Qt:

      https://doc.qt.io/qt-6/supported-platforms.html

      https://doc.qt.io/QtForDeviceCreation/

      https://doc.qt.io/qt-6/configure-linux-device.html

       

      Qt Creator:

      https://doc.qt.io/qtcreator/creator-os-supported-platforms.html

       

      Attachments

        Issue Links

          depends on

          Bug - A problem which impairs or prevents the functions of the product. QTBUG-84483 Document in more details the workflow of androiddeployqt scanning and deploying

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed
          is required for

          Epic - Created by Jira Software - do not edit or delete. Issue type for a big user story that needs to be broken down. QTBUG-84088 Device Creation documentation updates on 6.x

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Open
          relates to

          Epic - Created by Jira Software - do not edit or delete. Issue type for a big user story that needs to be broken down. QDS-3476 Only use one term to mean one thing across the UI and documentation

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Open

          Epic - Created by Jira Software - do not edit or delete. Issue type for a big user story that needs to be broken down. QTBUG-85207 Qt 6 documentation

          • P1: Critical - Urgent and Important, will STOP the release if matched with set FixVersion field. This includes regressions from the last version that are not edge cases; Data loss; Build issues; All but the most unlikely crashes/lockups/hanging; Serious usability issues and embarrassing bugs & Bugs critical to a deliverable. This is the highest possible priority for requirements.
          • Closed
          links to

          Web Link Platforms Docs Overhaul Confluence Page

          mentioned in

          Page Loading...

          Page Loading...

          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

              nick_bennett Nicholas Bennett
              rampe Rami Potinkara
              Veli-Pekka Heinonen Veli-Pekka Heinonen
              Votes:
              0 Vote for this issue
              Watchers:
              6 Start watching this issue

              Dates

                Created:
                Updated:

                Gerrit Reviews

                  There are no open Gerrit changes