Skip to content
  • Categories
  • Recent
  • Tags
  • Popular
  • Users
  • Groups
  • Search
  • Get Qt Extensions
  • Unsolved
Collapse
Brand Logo
  1. Home
  2. Qt Development
  3. General and Desktop
  4. Great job updating the Qt docs with a sidebar
QtWS25 Last Chance

Great job updating the Qt docs with a sidebar

Scheduled Pinned Locked Moved Unsolved General and Desktop
6 Posts 5 Posters 238 Views
  • Oldest to Newest
  • Newest to Oldest
  • Most Votes
Reply
  • Reply as topic
Log in to reply
This topic has been deleted. Only users with topic management privileges can see it.
  • A Offline
    A Offline
    ajpat
    wrote on 4 Apr 2025, 13:02 last edited by
    #1

    Just want to thank the Qt team for adding a sidebar. This is so much of a simpler mental model for anyone going through the docs. It saves me so much trouble as I know everything there is to know about a module instead of sifting through links and backlinks throughout pages.

    6d42be3a-4cd0-4247-9ae3-d09c490a0f66-image.png

    1 Reply Last reply
    7
    • P Offline
      P Offline
      Pedro
      Qt Community Manager
      wrote on 7 Apr 2025, 07:19 last edited by
      #2

      Hi @ajpat! Thanks for the feedback. Our team was really pleased to read your comment. :)

      If you have any thoughts or comments, documentation-related or not, feel free to reach out to me.

      J 1 Reply Last reply 7 Apr 2025, 07:32
      0
      • P Pedro
        7 Apr 2025, 07:19

        Hi @ajpat! Thanks for the feedback. Our team was really pleased to read your comment. :)

        If you have any thoughts or comments, documentation-related or not, feel free to reach out to me.

        J Offline
        J Offline
        JonB
        wrote on 7 Apr 2025, 07:32 last edited by JonB 4 Jul 2025, 07:40
        #3

        @Pedro
        Yes, I have a suggestion :) I only use the online documentation. For the past ten years when I want to find, say, a class (e.g. qsortfilterproxymodel) I have to (correctly) type in every character (no partial matches) to search for it in the docs' Search box. It would make a huge difference if that used something like Qt's QCompleter to offer me matching suggestions as I type, like many other sites do....

        If you don't want to do it on the page's Search box, which I think would be my preference, now that you have added the "sidebar" on the left for "table of contents" you might add a search/filter box at the top of that which searches/filters/completes just that table of contents or list of classes.

        J 1 Reply Last reply 7 Apr 2025, 07:54
        0
        • J JonB
          7 Apr 2025, 07:32

          @Pedro
          Yes, I have a suggestion :) I only use the online documentation. For the past ten years when I want to find, say, a class (e.g. qsortfilterproxymodel) I have to (correctly) type in every character (no partial matches) to search for it in the docs' Search box. It would make a huge difference if that used something like Qt's QCompleter to offer me matching suggestions as I type, like many other sites do....

          If you don't want to do it on the page's Search box, which I think would be my preference, now that you have added the "sidebar" on the left for "table of contents" you might add a search/filter box at the top of that which searches/filters/completes just that table of contents or list of classes.

          J Offline
          J Offline
          J.Hilk
          Moderators
          wrote on 7 Apr 2025, 07:54 last edited by
          #4

          @JonB what do you mean with on side search bar ? I'm using google to search through the online documentation! X)


          Be aware of the Qt Code of Conduct, when posting : https://forum.qt.io/topic/113070/qt-code-of-conduct


          Q: What's that?
          A: It's blue light.
          Q: What does it do?
          A: It turns blue.

          J 1 Reply Last reply 7 Apr 2025, 08:33
          0
          • J J.Hilk
            7 Apr 2025, 07:54

            @JonB what do you mean with on side search bar ? I'm using google to search through the online documentation! X)

            J Offline
            J Offline
            JonB
            wrote on 7 Apr 2025, 08:33 last edited by JonB 4 Jul 2025, 08:35
            #5

            @J-Hilk
            I use Google search a lot for docs too. But once I have a page open in the Qt docs it would be nicer to search from there, particularly if, say, I am looking at a particular Qt version in the docs so it sticks to that version where Google can vary. Anyway, especially if it gave me some kind of QCompleter type suggestions/completions, so I could see what is available and not worry about mistyping a long class name etc.

            This topic refers to the "sidebar" which has been added on the left of all Qt doc web pages. I note that includes, for instance, an entry for every Qt class. That means it might be more suitable for web devs to search if they do not want to add suggestions/completions to the existing Search box which is at the top right of each page. Instead I am vaguely suggesting they might want to add a new Search box at the head of this new list/table of contents at the top left (e.g. under where you pick the Qt version dropdown), since that list already has all class names in it. If I could be given suggestions/completions against what I type there that would suffice.

            1 Reply Last reply
            0
            • A Offline
              A Offline
              afalsa
              wrote on 8 Apr 2025, 17:20 last edited by
              #6

              In my case, I would like the Qt version documentation popup to always be visible, or even better, to be set only once, because every time I need to look for something, I have to change the Qt version.

              1 Reply Last reply
              0

              1/6

              4 Apr 2025, 13:02

              • Login

              • Login or register to search.
              1 out of 6
              • First post
                1/6
                Last post
              0
              • Categories
              • Recent
              • Tags
              • Popular
              • Users
              • Groups
              • Search
              • Get Qt Extensions
              • Unsolved