Documentation revamp update

[Nicolas Fella]

Am 04.04.25 um 14:47 schrieb Nicolas Fella:
> 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!

Hi,

an update to this update:

The master branches of Frameworks are now converted to QDoc. That means 
all new API documentation there must be written in QDoc syntax and the 
current api.kde.org is frozen.

The plan is to go live with the new site soon™.

Non-frameworks libraries can be added there as soon as they are 
converted to the new syntax. Please think twice before adding very large 
projects (like the entirety of KDE PIM) to it since we are still 
experimenting with the scalability of the new tooling and might need to 
restructure some things.

In the future it would make sense to go over the warnings emitted by the 
QDoc generation to spot issues in the markup, as well as a general pass 
over our documentation to look for outdated content (there's quite a few 
stuff there that still refers to KF5-era concepts for example).

Cheers

Nico