Documentation revamp update

Igor Mironchik igor.mironchik at gmail.com
Fri May 16 18:36:18 BST 2025


Hi.

Just checked out latest commit from kde-qdoc-common "Add md4qt" to see 
if everything is fine...

Almost everything is fine. I guess you changed some CSS or similar 
thing. So on my "md4qt C++ Classes" page I see to wide "Contents" 
column, and too narrow data column.

Look 
https://drive.google.com/file/d/1UZ5hHyfhi5z0NNV9t4I5eb__PeMpExDF/view?usp=drive_link

I'd like to have line breaks on "Contents" column instead of data column.

I guess these changes was made here:

Make website responsive

     - Fixed layout on narrow screens.
     - The sidebar is now sticky.
     - Fixed some dark mode issues.
     - Remove unused CSS.

Please have a look at it again on "md4qt C++ Classes" page example, not 
so good...

Thank you.

On 04.04.2025 15:47, Nicolas Fella wrote:
> Hi,
>
> I'm happy to announce a major milestone in our effort to improve our API
> documentation website by porting it to QDoc.
>
> We now have a preview of the new site available at
> https://api-staging.kde.org/, with all Frameworks converted to the new
> syntax.
>
> Please have a look and report any issues. We do have some flexibility
> regarding content and appearance, but please understand that we have to
> work within what QDoc provides, so we might not be able to accommodate
> all requests easily.
>
> One major thing that's currently missing is a search function. There's
> some thoughts and a WIP at
> https://invent.kde.org/teams/documentation/sprints/-/issues/81. Help
> with this and other web-development topics is welcome.
>
> Currently the documentation syntax changes for the frameworks are in a
> separate branch, we will merge these to master as we are going live with
> the new site.
>
> The current plan is to go live with Frameworks only once the site is
> ready, other libraries can be converted/added over time.
>
> You can find some instructions about converting in
> https://invent.kde.org/-/snippets/3206
>
> Thanks to everyone who contributed to this effort!
>
> Cheers
>
> Nico
>
>


More information about the kde-devel mailing list