Uploaded image for project: 'Qt Project Website'
  1. Qt Project Website
  2. QTWEBSITE-1136

Developers look at the wrong docs OFTEN. Visual differentiation would help

    XMLWordPrintable

Details

    • Suggestion
    • Resolution: Unresolved
    • P4: Low
    • None
    • None
    • doc.qt.io
    • None

    Description

      Background: When learning Qt, I mistook the version of Qt many times, which led to me struggling to write code because "qt creator won't recognize a property that the docs says this object has!".

      And I am not alone. Other coworkers have admitted do doing the same thing often. Now that I'm on the teaching and support side, I have clients asking me "Why isn't this thing working?" when they're looking at Qt5 docs, but their app is Qt6.

      And I believe this kind of thing goes as unpaid support.

      I believe that this is a waste of our expensive time, of client's invaluable time, and a deterrent for anyone who tries to learn Qt on their own.

      The most obvious fiend is Qt 5 and Qt 6.
      Even just greying the background of Qt5 docs would probably significantly reduce the number of mistakes.

      Flipping the nav bar to the right for C++ docs versus QML docsĀ  might be an option.

      Changing the main page color or font or something would help distinguish QUL docs.

      I'm just going off the top of my head, but I'm sure that there are many easy fixes that would save a lot of headaches.

      Attachments

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

        Activity

          People

            docinfrastructure Documentation Infrastructure Team
            mairtin.s Mairtin Steinkamp
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:

              Gerrit Reviews

                There are no open Gerrit changes