<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
<div class="moz-cite-prefix">Am 04.04.25 um 17:24 schrieb Méven:<br>
</div>
<blockquote type="cite"
cite="mid:CAOvFf8OaW9LgrAHJudKd_Cw9LjgXiryf=ByD6mUOx9x=ybohdA@mail.gmail.com">
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<div dir="ltr">
<div>Hi,</div>
<div><br>
</div>
<div>> I'm happy to announce a major milestone in our effort
to improve our API<br>
documentation website by porting it to QDoc.</div>
<div><br>
</div>
<div>Great \o/</div>
<div><br>
</div>
<div>> Please have a look and report any issues. We do have
some flexibility<br>
regarding content and appearance, but please understand that
we have to<br>
work within what QDoc provides, so we might not be able to
accommodate<br>
all requests easily.</div>
<div><br>
</div>
<div>The root page is very tall, maybe we could have some table
to display libraries in in two columns per tier.</div>
<div>Or we could have a menu with links to tiers sections.</div>
</div>
</blockquote>
<p>In principle we could replicate
<a class="moz-txt-link-freetext" href="https://doc.qt.io/qt-6/index.html">https://doc.qt.io/qt-6/index.html</a>, it's "just" a matter of
applying some CSS. Unfortunately their stylesheets are not part of
the upstream Qt repos.<br>
</p>
<p><br>
</p>
<blockquote type="cite"
cite="mid:CAOvFf8OaW9LgrAHJudKd_Cw9LjgXiryf=ByD6mUOx9x=ybohdA@mail.gmail.com">
<div dir="ltr">
<div>In <a
href="https://api-staging.kde.org/kservice-index.html"
moz-do-not-send="true" class="moz-txt-link-freetext">https://api-staging.kde.org/kservice-index.html</a></div>
<div>KService links does not link to <a
href="https://api-staging.kde.org/kservice.html"
moz-do-not-send="true" class="moz-txt-link-freetext">https://api-staging.kde.org/kservice.html</a></div>
</div>
</blockquote>
<p>Yeah that's an unfortunate side-effect of how QDoc resolves
links. I tried to work around it but couldn't make it work.</p>
<p><br>
</p>
<blockquote type="cite"
cite="mid:CAOvFf8OaW9LgrAHJudKd_Cw9LjgXiryf=ByD6mUOx9x=ybohdA@mail.gmail.com">
<div dir="ltr">
<div><br>
</div>
<div>The site icon (favicon) is Qt's, surely we can do something
about it.</div>
<div>Please not the same icon as the one on <a
href="https://invent.kde.org" moz-do-not-send="true"
class="moz-txt-link-freetext">https://invent.kde.org</a></div>
</div>
</blockquote>
<p>This should be fixed with the next site rebuild</p>
<br>
<blockquote type="cite"
cite="mid:CAOvFf8OaW9LgrAHJudKd_Cw9LjgXiryf=ByD6mUOx9x=ybohdA@mail.gmail.com">
<div dir="ltr">
<div>We have since mentions dating way back. For instance: <a
href="https://api-staging.kde.org/kwindowsystem.html"
moz-do-not-send="true" class="moz-txt-link-freetext">https://api-staging.kde.org/kwindowsystem.html</a></div>
<div>We might want to remove those from KF5, maybe not in code,
but at least in doc.</div>
<div>Or New/recent API could be highlighted. Like having some
style to differentiate the recency of the since might be nice.</div>
<div>Or that'd be for the code change phase or later.</div>
</div>
</blockquote>
<p>QDoc has a global switch to ignore the since information before a
given version. I have now set this to 6.0<br>
</p>
<p><br>
</p>
<blockquote type="cite"
cite="mid:CAOvFf8OaW9LgrAHJudKd_Cw9LjgXiryf=ByD6mUOx9x=ybohdA@mail.gmail.com">
<div dir="ltr">
<div><br>
</div>
<div>This feels very nice, to have the same navigation and style
as Qt's doc, and links back to Qt's doc when their classes are
mentioned.</div>
<div><br>
</div>
<div>> One major thing that's currently missing is a search
function.</div>
<div><br>
</div>
<div>Great to hear there is yet some effort going on. This feels
like an important missing piece.</div>
</div>
</blockquote>
<p>There is some ideas on
<a class="moz-txt-link-freetext" href="https://invent.kde.org/teams/documentation/sprints/-/issues/81">https://invent.kde.org/teams/documentation/sprints/-/issues/81</a>,
but it needs somebody to step up and finish it, otherwise we'll
have to launch without a search bar.</p>
<p>Note that you can still search via "site:api-staging.kde.org Foo"
in your favorite search engine.</p>
<p><br>
</p>
<blockquote type="cite"
cite="mid:CAOvFf8OaW9LgrAHJudKd_Cw9LjgXiryf=ByD6mUOx9x=ybohdA@mail.gmail.com">
<div dir="ltr">
<div><br>
</div>
<div>> Thanks to everyone who contributed to this effort!</div>
<div><br>
</div>
<div>Thanks to all of you and Nicolas.</div>
</div>
<br>
<div class="gmail_quote gmail_quote_container">
<div dir="ltr" class="gmail_attr">Le ven. 4 avr. 2025 à 14:53,
Nicolas Fella <<a href="mailto:nicolas.fella@gmx.de"
moz-do-not-send="true" class="moz-txt-link-freetext">nicolas.fella@gmx.de</a>>
a écrit :<br>
</div>
<blockquote class="gmail_quote"
style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">Hi,<br>
<br>
I'm happy to announce a major milestone in our effort to
improve our API<br>
documentation website by porting it to QDoc.<br>
<br>
We now have a preview of the new site available at<br>
<a href="https://api-staging.kde.org/" rel="noreferrer"
target="_blank" moz-do-not-send="true"
class="moz-txt-link-freetext">https://api-staging.kde.org/</a>,
with all Frameworks converted to the new<br>
syntax.<br>
<br>
Please have a look and report any issues. We do have some
flexibility<br>
regarding content and appearance, but please understand that
we have to<br>
work within what QDoc provides, so we might not be able to
accommodate<br>
all requests easily.<br>
<br>
One major thing that's currently missing is a search function.
There's<br>
some thoughts and a WIP at<br>
<a
href="https://invent.kde.org/teams/documentation/sprints/-/issues/81"
rel="noreferrer" target="_blank" moz-do-not-send="true"
class="moz-txt-link-freetext">https://invent.kde.org/teams/documentation/sprints/-/issues/81</a>.
Help<br>
with this and other web-development topics is welcome.<br>
<br>
Currently the documentation syntax changes for the frameworks
are in a<br>
separate branch, we will merge these to master as we are going
live with<br>
the new site.<br>
<br>
The current plan is to go live with Frameworks only once the
site is<br>
ready, other libraries can be converted/added over time.<br>
<br>
You can find some instructions about converting in<br>
<a href="https://invent.kde.org/-/snippets/3206"
rel="noreferrer" target="_blank" moz-do-not-send="true"
class="moz-txt-link-freetext">https://invent.kde.org/-/snippets/3206</a><br>
<br>
Thanks to everyone who contributed to this effort!</blockquote>
</div>
</blockquote>
</body>
</html>