What kind of overviews do you miss in the Qt documentation?
-
@kkoehne what in my opinion is lagging is
a) a proper search engine :D I find myself using the google search, with restriction to the documentation rather, than browse/search through it myself e.g
site:https://doc.qt.io QWidgetb) the bug, that the table of content is simple missing, if your browser is to small, is terrible!
Missing:
There:
Same that the table of content is not scrollable, you have to scroll to the end of the page for the table to be able to scroll
c) A proper overview of all Qt Classes and Modules that exists. I often enough stumble over classes I had no idea existed :D
Thanks J-Hilk for your input!
@J-Hilk said in What kind of overviews do you miss in the Qt documentation?:
a) a proper search engine :D I find myself using the google search, with restriction to the documentation rather, than browse/search through it myself e.g site:https://doc.qt.io QWidget
We're actually using google for the search box on doc.qt.io too, so your experience shouldn't really differ ;)
That said, we recently noticed a bug where google was not indexing all pages anymore due to the sheer size. Anyhow, we have solved this now by explicitly de-listing pages in the archive. We furthermore now marked the Qt 6 documentation as 'canonical', and added a selection box for you to easily go to other supported versions.
All inall, the search results should now give better results, be it from google.com or from the search box.
b) the bug, that the table of content is simple missing, if your browser is to small, is terrible!
Well ... that's a feature to show enough content also on smaller screens. When the width is too low, we first hide the right toc, and then the left toc, to make sure there is sufficient space for the actual content (middle column). What we could do maybe is tweak the exact points where this happens, but in general, I think it makes sense and is fairly standard (check out e.g. the microsoft API documentation). Or we somehow merge the global TOC, and the site-specific TOC to the left side. But I'm not sure this would be an improvement overall.
-
@SimonSchroeder said in What kind of overviews do you miss in the Qt documentation?:
Or do you have something different in mind?
Actually I had different grouping in mind, something like:
"Persistent Storage/Memory"
- QFile
- QFileSystemWatcher
- QSettings
- .... etc
And I wasn't really aware of the general classes in module overview! How do you navigate there from QtCore, if you don't know it exists?
@J-Hilk said in What kind of overviews do you miss in the Qt documentation?:
Actually I had different grouping in mind, something like:
"Persistent Storage/Memory"QFile
QFileSystemWatcher
QSettings
.... etcMaybe something like https://doc.qt.io/qt-6/io.html ? Granted, it is a bit hard to find currently, you have to go to "All Qt Reference Documentation", "Groups Of Related Classes" ...
How about adding a a 'back-link' e.g. to the respective class documentation ?
-
@JoeCFD, thanks for the feedback. Having examples that also show architecture & good coding practices is indeed something raised often. Anyhow, the challenge is to make the examples still simple enough, so that you're not overburdened with the details of a real world app.
Do you have a specific open source project or use case in mind that would make up a good example?
-
I miss the days of the Trolltek docs...you know, before it was redone in low contrast style sheets. After about 2007 most web interfaces just look like white noise and/or clutter to me.
-
FWIW, do not pin these posts...it's annoying.
-
I miss the days of the Trolltek docs...you know, before it was redone in low contrast style sheets. After about 2007 most web interfaces just look like white noise and/or clutter to me.
@Kent-Dorfman said in What kind of overviews do you miss in the Qt documentation?:
After about 2007 most web interfaces just look like white noise and/or clutter to me.
So much for the Internet then... ;-)
-
@JoeCFD said in What kind of overviews do you miss in the Qt documentation?:
@kkoehne Qt Creator can be one of them.
Hi JoeCFD, can you explain a bit? I'm not actually sure what sub-discussion you're replying to ...
-
I miss the days of the Trolltek docs...you know, before it was redone in low contrast style sheets. After about 2007 most web interfaces just look like white noise and/or clutter to me.
@Kent-Dorfman said in What kind of overviews do you miss in the Qt documentation?:
miss the days of the Trolltek docs...you know, before it was redone in low contrast style sheets. After about 2007 most web interfaces just look like white noise and/or clutter to me.
If the documentation is to bright for you, doc.qt.io features a dark mode since a while ...
https://www.qt.io/blog/dark-theme-for-qt-online-documentation
-
@JoeCFD said in What kind of overviews do you miss in the Qt documentation?:
@kkoehne Qt Creator can be one of them.
Hi JoeCFD, can you explain a bit? I'm not actually sure what sub-discussion you're replying to ...
-
Qt samples are not large enough. Include a few Qt-based open source applications and provide detailed step-by-step instructions.
