Great job updating the Qt docs with a sidebar
-
wrote on 4 Apr 2025, 13:02 last edited by
-
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.
-
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.
wrote on 7 Apr 2025, 07:32 last edited by JonB 4 Jul 2025, 07:40@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'sQCompleter
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.
-
@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'sQCompleter
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.
@JonB what do you mean with on side search bar ? I'm using google to search through the online documentation! X)
-
@JonB what do you mean with on side search bar ? I'm using google to search through the online documentation! X)
wrote on 7 Apr 2025, 08:33 last edited by JonB 4 Jul 2025, 08:35@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 ofQCompleter
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.
-
wrote on 8 Apr 2025, 17:20 last edited by
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/6